get https://api.similarweb.com/v3/batch/reports/history
Get information about all the reports that were requested.
Response
The response consists of items and total. Under items are a list of Report Items, representing the requested reports. total specifies the number of reports.
Report Item Response Object
| Property | Description | Example |
|---|---|---|
| report_id string | ID of the requested report, as returned by the '/request-report' endpoint. | |
| report_name string | Name of the requested report. | "Example" |
| user_id string | ID of the user. | "5545647" |
| state string | Status of the report request, as returned by the '/request-report' endpoint. | "pending", "processing", "completed" |
| used_quota integer | Number of credits actually charged after the report was generated. | 3213 |
| create_date string | Date the report was requested. | "2024-09-10 11:11:30" |
| table string | Name of the table used. | "traffic_and_engagement", "site_conversion" |
| start_date string | Start date of the report data. | "2024-07" |
| end_date string | End date of the report data. | "2024-07" |
| delivery_method string | How the report is delivered. | "download_link", "bucket_access", "snowflake" |
| granularity string | Granularity of data in the report. | "daily", "monthly", "yearly" |
| refunded boolean | Specifies if user was refunded for the request (in case of failure). | true, false |
| retention_days integer | Number of days before the report is expired. | 30 |