Skip to main content

Reporting Overview

M
Written by Megan Pratt
Updated over a month ago

All reporting resources share a common set of request parameters, documented below. Note that the order of fields in the payload does not matter.

πŸ“˜

Code Examples

To better understand how these parameters can be used, see the Code Examples.

Report Parameters

REQUIRED.

Parameter

Type

Description

start_date

string

The start date and time for the range to show in the response (inclusive of the hour)

Format: yyyy-mm-ddThh:mm:ssZ (minutes and seconds are ignored). Date-only format, yyyy-mm-dd, will default to the 00:00:00 hour:minute:second.

end_date

string

The end date and time for the range to show in the response (inclusive of the hour).

Format: yyyy-mm-ddThh:mm:ssZ (minutes and seconds are ignored). Date-only format, yyyy-mm-dd, will default to the 00:00:00 hour:minute:second.

To capture full day of an end_date, use the 23rd hour,yyyy-mm-ddT23:00:00.

timezone

string

Retrieve data based on timezone (default: UTC)

resolution

string

Time breakdown for the results being returned.

Supported: hourly, daily, weekly, monthly, day of week, totals

metrics

breakdown

filters

exclude_filters

Pagination Parameters

OPTIONAL. If not in the request, default values will apply.

Parameter

Type

Description

page

integer

The page of results to be returned (default: 1)

page_size

integer

Number of results to be returned (default: 10000)

Sorting Parameters

OPTIONAL.

Parameter

Type

Description

sort_by

string

Specify the name of the breakdown or metric to sort by

sort_order

string

Specify asc or desc as sorting order

Did this answer your question?