Create a report
Creates a new report.
Reports are created as pending initially while Paddle generates your report. They move to ready when they're ready to download.
You can download a report when it's ready using the get a CSV file for a report operation.
If successful, your response includes a copy of the new report entity.
Request Body
Type of report to create.
Filter criteria for this report. If omitted, reports are filtered to include data updated in the last 30 days. This means updated_at is greater than or equal to (gte) the date 30 days ago from the time the report was generated.
Field name to filter by.
Operator to use when filtering. Valid when filtering by updated_at, null otherwise.
Value to filter by. Check the allowed values descriptions for the name field to see valid values for a field.
Response
Represents a report entity.
Unique Paddle ID for this report, prefixed with rep_
Status of this report. Set automatically by Paddle.
Reports are created as pending initially, then move to ready when they're available to download.
Number of records in this report. null if the report is pending.
Type of report.
List of filters applied to this report.
RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date.
RFC 3339 datetime string of when this report was last updated.
RFC 3339 datetime string of when this report was created.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
12345678910111213141516171819201{
2 "type": "transactions",
3 "filters": [
4 {
5 "name": "collection_mode",
6 "value": [
7 "manual"
8 ]
9 },
10 {
11 "name": "updated_at",
12 "value": "2024-04-15",
13 "operator": "lt"
14 },
15 {
16 "name": "updated_at",
17 "value": "2024-01-01",
18 "operator": "gte"
19 }
20 ]