Apis::V4::Reports API

get organization interactions report

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
period ISO8601 Duration. Examples: P1W, P1M, P3M, P6M, P1Y, P3W2DT8H2M
organization_ids Comma separated list of organization ids: 1,2,3. Defaults to all organizationsof the current user
end_date Date (YYYY-MM-DD) report ends on. Defaults to Today.
fields A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example

Response Fields

Name Description
data primary JSON API payload

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo5NSwiZXhwIjoxNzA0NDczMjI3LCJpYXQiOjE3MDQ0NzMwNDd9.7UJBiyBspljIQ7HsZEyV6MHk5fwptLVHKsTFeQGjb8A
Host: example.org
Cookie: 

Route

GET /apis/v4/reports/organizations?organization_ids=54%2C55&period=P1W

Query Parameters

organization_ids=54,55
period=P1W

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"ea83b1a79560221d7dfe3358765c575d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: cd27bd57-4953-4809-986e-ff3c9dc48378
X-Runtime: 0.024730
Content-Length: 429

Status

200

Body