Groups
Model
A group (or campaign) is a collection of datapoints, this is the model represented through JSON for API interaction. Some fields are maked as optional as in they don’t need to be present in a minimum working group.
GET /groups
Retrieve a list of groups associated to the current authenticated user.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: EntityURIList (see “Common models”)
Filters:
-
offset [optional] [integer, 0] : Where to start when retrieving groups
-
limit [optional] [integer, 20] : Maximum elements to retrieve
-
createdBefore [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the group
-
createdAfter [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the group
-
status [optional] [string, all] : Status of the datapoint, possible statuses are active, deleted, and all (all statuses)
-
tags [optional] [string] : A comma separated list of tags you want to filter by
GET /groups/count
Retrieve a count of the groups associated to the current authenticated user.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: CountObject (see “Common models”)
Filters:
-
offset [optional] [integer, 0] : Where to start when retrieving groups
-
limit [optional] [integer, 20] : Maximum elements to retrieve
-
createdBefore [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the group
-
createdAfter [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the group
-
status [optional] [string, all] : Status of the datapoint, possible statuses are active, deleted, and all (all statuses)
-
tags [optional] [string] : A comma separated list of tags you want to filter by
POST /groups
Create a group for the current authenticated user.
Input: Group (one without id)
Result: EntityURI (uri of the newly created group)
GET /groups/{id}
Retrieve the group {id} for the current authenticated user.
Result: Group
DELETE /groups/{id}
Delete the group {id} for the current authenticated user.
Result: EntityURI
POST /groups/{id}
Update the group {id} for the current authenticated user.
Input: Group (the one you fetched from GET /groups/{id} with your modifications)
Result: EntityURI
GET /groups/{id}/datapoints
Retrieve a list of datapoints associated to the current authenticated user for the group {id}.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: EntityUriList (see “Common models”)
Filters:
-
offset [optional] [integer, 0] : Where to start when retrieving datapoints
-
limit [optional] [integer, 20] : Maximum elements to retrieve
-
createdBefore [optional] [string] : A date in the format YYYYMMDDHHmm thath will filter by creation date of the datapoint
-
createdAfter [optional] [string] : A date in the format YYYYMMDDHHmm thath will filter by creation date of the datapoint
-
type [optional] [string] : Type of datapoint to retrieve (TL is tracking link, TP is trackinge pixel)
-
status [optional] [string, all] : Status of the datapoint, possible statuses are active, deleted, paused, spam, deleted and all (all statuses)
-
tags [optional] [string] : A comma separated list of tags you want to filter by
POST /groups/{id}/datapoints
Create a datapoint for the current authenticated user in the group {id}.
Input: Datapoint (one without id)
Result: EntityURI (uri of the newly created datapoint)
For more info read this FAQ:
0 Comments