Summary Object
All GET responses contain a summary object with information about the request. For the sake of brevity, we will not duplicate the summary object elsewhere in the examples. This functionality should be assumed for all GET responses.
A sample summary object:
200
{
"summary": {
"status": 200,
"message": "OK",
"results": 3,
"start_date": "2013-03-27T00:00:00+00:00",
"end_date": "2013-03-27T23:59:59+00:00",
"offset": 0,
"limit": 100,
"previous": null,
"next": null,
"params": {
"start_date": null,
"end_date": null,
"offset": null,
"limit": null
}
}
}
Summary Params
Field
Type
Description
status
Integer
The HTTP header response code returned
message
String
The HTTP header response code message returned
results
Integer
The total number of records returned across all pages.
start_date
String
The optional start timestamp of the activities you wish to pull in the ISO 8601 standard format”YYYY-MM-DDThh:mm:ssZ” (e.g., “2013-03-28T14:32:00+00:00” where “+00:00” is the UTC offset). Defaults to yesterday’s start of day (e.g., “2013-03-27T00:00:00+00:00”). May be set in GET request (e.g., &start_date=2013-03-28T14:32:00+00:00).
end_date
String
The optional end timestamp of the activities you wish to pull in the ISO 8601 standard format”YYYY-MM-DDThh:mm:ssZ” (e.g., “2013-03-28T14:32:00+00:00” where “+00:00” is the UTC offset). Defaults to yesterday’s end of day (e.g., “2013-03-27T23:59:59+00:00”). May be set in GET request (e.g., &end_date=2013-03-28T14:32:00+00:00).
offset
Integer
Record offset for retrieving paginated records. Default is 0. May be set in GET requests
limit
Integer
Limit of records returned per page. Default is 100. Must be an integer between 1 and 200. May be set in GET request.
previous
String
The URI of the previous page in the feed.
next
String
The URI of the next page in the feed.