Apis::V4::Reports API

get people 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
people_ids Comma separated list of people ids: 1,2,3. Defaults to all people of the current user.
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
contacts_with_interaction_count The number of contacts the person has an interaction, but notan accepted step with in the organization

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo4NywiZXhwIjoxNzA0NDczMjI3LCJpYXQiOjE3MDQ0NzMwNDd9.v2yEgf2p1c_hU7fiJTUWUfeTBvBAeC-U8RJBPn-eKRY
Host: example.org
Cookie: 

Route

GET /apis/v4/reports/people?people_ids=128%2C129%2C130&period=P1W

Query Parameters

people_ids=128,129,130
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/"4df1d446c09e249a7404d448eaacfca7"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 392228d6-e3e7-4bec-9a1b-065dc7618bdd
X-Runtime: 0.026909
Content-Length: 408

Status

200

Body