Custom Events Analytics

v1.0.0

This endpoint allows you to retrieve a series of the number of occurrences of a custom event in your app over a designated time period.

Components Used

Response

json

Content-Type: application/jsonAuthorization: Bearer YOUR-REST-API-KEY{    "message": (required, string) the status of the export, returns 'success' when completed without errors,    "data" : [        {            "time" : (string) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",            "count" : (int)        },        ...    ]}

Fatal Error Response Codes

The following status codes and associated error messages will be returned if your request encounters a fatal error. Any of these error codes indicate that no data will be processed.

Error Code	Reason / Cause
400 Bad Request	Bad Syntax
401 Unauthorized	Unknown or missing REST API Key
429 Rate Limited	Over rate limit
5XX	Internal server error, you should retry with exponential backoff

Input

{
  "type": "object",
  "properties": {
    "app_id": {
      "type": "string"
    },
    "ending_at": {
      "type": "string"
    },
    "event": {
      "type": "string"
    },
    "length": {
      "type": "string"
    },
    "segment_id": {
      "type": "string"
    },
    "unit": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}