Reports

Custom events detail listing

Get a summary of custom event counts and values, by custom event, within the specified time period.

get/api/reports/events

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopesrpt
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/reports/events/get.ts
A function with typed inputs. Its response is checked against the schema.

startstring date-time required

Example:2021-02-01T00:00:00

A date-time for start of report.

endstring date-time required

Example:2021-02-28T00:00:00

A date-time for end of report.

precision'HOURLY' | 'DAILY' | 'MONTHLY'

Granularity of results to return. Defaults to DAILY.

pageinteger

Example:5

Identifies the desired page number. Defaults to 1. If page is given a negative or out of bounds value, the default value will be used.

page_sizeinteger

Example:25

Specifies how many results to return per page. Has a default value of 25 and a maximum value of 100.

Returned on success, with the JSON representation of the events in the body of the response.

next_pagestring url

There might be more than one page of results for this listing. Follow this URL if it is present to the next batch of results.

okboolean

Success.

prev_pagestring url

Link to the previous page, if available.

total_countinteger

Sum of all the count fields in the above array.

total_valueinteger

Sum of all the value fields in the above array.

{
  "events": [
    {
      "count": 4,
      "location": "custom",
      "name": "custom_event_name"
    }
  ],
  "total_count": 12
}