v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Statistics

Aggregate Event Types

Creates a background task to calculate the listed event types for all apps in the organization.

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": "event-type.aggregate",
  "data": {
    "event_types": [
      {
        "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m",
        "explicitlySubscribedEventTypes": ["user.signup", "user.deleted"],
        "hasCatchAllEndpoint": false
      }
    ]
  }
}
put/api/v1/stats/usage/event-types

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
updatedAtstring date-time required

Example response

{
  "id": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}