Skip to content

Create aggregated api metrics report

Request

Create a report of aggregated api request metrics for a given time range and list of organisations.

Security
api_key
Bodyapplication/jsonrequired

request aggregated api request metrics data for a set of orgs and a given time range.

clientIdsArray of strings

A list of IDs of the clients to fetch the data for.

endDatestring, (date)

It is the upper bound of the date range for which to return data. The endDate is non-inclusive; i.e, the returned data will be for dates from startDate to endDate-1

startDatestring, (date)

It is the lower bound of the date range for which to return data. The startDate is inclusive; i.e, the returned data will be for dates from startDate to endDate-1

curl -i -X POST \
  https://coreapi.hoxton.ai/_mock/v1/aggregated-api-request-metrics-reports \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientIds": [
      "string"
    ],
    "endDate": "2019-08-24",
    "startDate": "2019-08-24"
  }'

Responses

OK.

Bodyapplication/json
Array [
clientIDstringread-only
dailyAPICallCountinteger or nullread-only
dailyActiveUserinteger or nullread-only
organisationIDstring, (uuid)read-only
timestring, (date-time)read-only
]
Response
[
  {
    "clientID": "string",
    "dailyAPICallCount": 0,
    "dailyActiveUser": 0,
    "organisationID": "c9a1447d-b72f-46e6-b1d0-da6e4d92aa47",
    "time": "2019-08-24T14:15:22Z"
  }
]