Create report

post https://testflight.tremendous.com/api/v2/reports

Creating a report allows your organization to programmatically retrieve information that's available in our dashboard UI.

This request creates a new report object with a unique ID, and kicks off an async report generation.

To retrieve a completed report, either poll /api/v2/reports/{id} or listen for REPORTS webhook event.

Request body

Property Type Description

report_type

string

Type of report for retrieval.

Report type	Description
`digital_rewards`	Report for Tremendous digital reward history

format

string

Format the report will be generated in.

Format	Description
`csv`	CSV format for report

filters

object

Filters to apply to the report. Corresponds to the filters provided in the dashboard

Show object properties

Property Type Description

digital_rewards

object

Filters object for a report_type: digital_rewards report

Show object properties

Property Type Description

amount

object

Amount of the rewards returned in the report

Show object properties

Property	Type	Description
`gte`	number double	Minimum amount of the rewards that should be returned in the report
`lte`	number double	Maximum amount of the rewards that should be returned in the report

campaign_id

string

ID of the Tremendous campaign that this report should be limited to

created_at

object

Creation dates of rewards returned in the report

Show object properties

Property	Type	Description
`gte`	string date	Minimum date the reward was created
`lte`	string date	Maximum date the reward was created

delivered_at

string date

Delivery date for gifts that should be returned in the report

delivery_method

string

Delivery method for rewards returned in the report

order_id

string

ID of the Tremendous order that this report should be limited to

order_status

string

Order status for rewards returned in the report

status

array string

Status for rewards returned in the report

Rate limits

Some reports may take a long time to generate and we limit the number of reports that can be simulataneously generated by an organization at a given time. If you exceed the rate limit, you'll receive a 429 response.