SVsvix
Statistics

Aggregate App Stats

Changed on

Creates a background task to calculate the number of message attempts (messageDestinations) made for all applications in the environment.

Note that this endpoint is asynchronous. You will need to poll the Get Background Task endpoint to retrieve the results of the operation.

The completed background task will return a payload like the following:

{
  "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT",
  "status": "finished",
  "task": "application.stats",
  "data": {
    "appStats": [
      {
        "messageDestinations": 2,
        "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m",
        "appUid": null
      }
    ]
  }
}
post/api/v1/stats/usage/app

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/stats/usage/app
  • Auth
    HTTP bearer

Headers

idempotency-keystring

The request's idempotency key

Request body

appIdsstring[] nullable

Specific app IDs or UIDs to aggregate stats for.

Note that if none of the given IDs or UIDs are resolved, a 422 response will be given.

sincestring date-time required
untilstring date-time required

Example request

{
  "appIds": [
    "unique-identifier"
  ]
}

Response

idstring required

The QueueBackgroundTask's ID.

status'running' | 'finished' | 'failed' required
task'endpoint.replay' | 'endpoint.recover' | 'application.stats' | 'message.broadcast' | 'sdk.generate' | 'event-type.aggregate' | 'application.purge_content' | 'endpoint.bulk-replay' required
unresolvedAppIdsstring[] required

Any app IDs or UIDs received in the request that weren't found.

Stats will be produced for all the others.

updatedAtstring date-time required

Example response

{
  "id": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "unresolvedAppIds": [
    "unique-identifier"
  ]
}

Changes