getInvitationsReceivedPerUserStats

A GET request that returns the number of Situation invitations received for a given user each hour within a given time range.

Back to Stats API.

Request arguments

Endpoint getInvitationsReceivedPerUserStats takes the following request arguments.

Name	Type	Description
`auth_token`	String	A valid `auth_token` returned from the `authenticate` request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.
`users`	Array	An array of user IDs. If no users are provided, the endpoint does not return any data.
`from`	Number	Start of the reporting time range. This is a Unix epoch timestamp in seconds.
`to`	Number	End of the reporting time range. This is a Unix epoch timestamp in seconds. If this timestamp is within 10 seconds of the current system time, the last datapoint returned is the current state datapoint.
`aggregation`	String	Set to: `accumulate`: Gradually adds data points together over time. `none`: No aggregation of data points.

Response

Endpoint getInvitationsReceivedPerUserStats returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Successful requests return a JSON object containing the following:

Name	Type	Description
`target`	String	"Invitations Received (full name)"
`datapoints`	Number Array	An array of data points. Each data point is an array in the format [data point, timestamp]: Data point: Invitations received by the user. Timestamp: Calculation time (Unix epoch timestamp in milliseconds). Less than 1 week: Returns the number of Situation invitations each hour in the time period. 1 week to 1 month: Returns the number of Situation invitations each day in the time period. 1 month to 1 year: Returns the number of Situation invitations each week in the time period. More than 1 year: Returns the number of Situation invitations each month in the time period.

Examples

The following examples demonstrate typical use of endpoint getInvitationsReceivedPerUserStats:

Request example

A cURL request for the number of Situation invitations for users 7 and 8 from midnight on Sunday, 14th October until 6am on Monday, 15th October 2018:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getInvitationsReceivedPerUserStats" --data-urlencode 'users=[7,8]' --data-urlencode 'from=1539558000' --data-urlencode 'to=1539583200' --data-urlencode 'aggregation=none'

Response example

A successful response returns the number of invitations for users 7 and 8:

[{
        "datapoints": [
                [1.0,1539558000000],
                [1.0,1539561600000],
                [2.0,1539565200000],
                [5.0,1539568800000],
                [0.0,1539572400000],
                [7.0,1539576000000],
                [1.0,1539579600000],
                [0.0,1539583200000],
                [8.0,1539586800000],
                [1.0,1539579600000],
                [2.0,1539583200000],
                [0.0,1539586800000],
        ],
        "target": "Invitations Received (Peter Parker/Kat Knight)"
}]

In this section: