API Resources

Author - Group Previews API

Create smart group preview rules and display its memberships

Interfaces

Object Synopses

Rule

  • id Integer or null

    Null when adding a new group. Rule id.

  • custom_field_id Integer

    Id of the custom field on which the rule is built.

  • predicate String

    Logical predicate for rule

  • value String

    Value to match

Create a smart group preview

POST /api/author/group_previews

Parameters

  • rules Rule[] Required

    An array of Rules.

  • join_type String [ intersect, union ]

    A string indicating how to join the rules. Default is intersect.

Example Response

{
  "id": "uuid-secret-123"
}

Get a list of learners for smart group preview

GET /api/author/group_previews/:id

Parameters

  • id String Required

    Path parameter. The id returned from creating a smart group preview.

Example Response

{
  "meta": {
    "total": 1
  },
  "learners": [
    {
      "id": "5",
      "avatar_url": null,
      "completed_courses_count": 0,
      "name": "Luke Skywalker",
      "next_due_date": "2015-07-24T18:58:01.344Z"
    }
  ]
}