v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Groups

List Exclusion Groups

List Exclusion Groups under a Project

get/groups

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

pageinteger

Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.

project_idinteger required

The ID of the Project you would like to list all Exclusion Groups for

Response

Return all Exclusion Groups in the specified Project

archivedboolean

Whether the group is archived

createdstring date-time

The time when the Exclusion Group was initially created

descriptionstring

The description for an Exclusion Group

idinteger

The unique identifier for the Exclusion Group

last_modifiedstring date-time

The last time the Exclusion Group was modified

namestring required

Name of the Exclusion Group

project_idinteger required

The Project the Exclusion Group is in

Example response

[
  {
    "entities": [
      {
        "id": 1234,
        "kind": "Experiment",
        "weight": 5000
      }
    ],
    "id": 3000,
    "name": "Homepage Group",
    "project_id": 1000
  }
]