Apis::V4::Reports API

get global impact report

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
person_id Id of the person to scope the report to. Accepts "me" to refer to the current user's person. Defaults to all people if the parameter is not supplied.
organization_id Id of the organization to scope the report to. Defaults to all organizations if the parameter is not supplied.
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 type
data primary JSON API payload
data[attributes][steps_count] The number of steps taken within the given person and organization parameters, from the beginning of the calendar year until now. This number considers both challenges and interactions. Number
data[attributes][receivers_count] The number of unique poeple that received the steps. Number
data[attributes][step_owners_count] The number of unique poeple that created/owned the steps. Number
data[attributes][pathway_moved_count] The number of unique poeple that moved from one pathway stage to another. Number
data[attributes][person_id] The id of the person that the counts are scoped to. Number
data[attributes][organization_id] The id of the organization that the counts are scoped to. Number

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo3OSwiZXhwIjoxNzA0NDczMjI2LCJpYXQiOjE3MDQ0NzMwNDZ9.0g_TdCA4ggZLT7RAf2aez3GTsSsBTuXBRWQGdDTa2h8
Host: example.org
Cookie: 

Route

GET /apis/v4/reports/impact?person_id

Query Parameters

person_id=

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/"bb096716ca16220c8643996a67053f7d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2b0f647c-6a75-427c-ab5d-c108bc1758b5
X-Runtime: 0.019074
Content-Length: 244

Status

200

Body