get https://api.similarweb.com/v3/batch/request-status/
Get the current status of the requested report.
Response
Request Status
| Value | Description |
|---|---|
| pending | Request received, waiting for processing. |
| processing | Processing started. |
| completed | Report generated. Data is ready to use |
| retry | Request is re-tried, waiting for processing. |
| bad request | User error. In this case read error message and apply fix. |
| internal error | Server error. In this case contact support or retry. |
In Progress Response
This response object will be shown when the request is in progress.
| Property | Description | Example |
|---|---|---|
| status string | The status of the request. | "pending", "processing", "retry" |
Completed Response
This response object will be shown when the request is completed.
| Property | Description | Example |
|---|---|---|
| used_quota integer | The used data credits. | 35589 |
| download_url string | Optional, depending on the delivery method. The url that is used to download the generated report. | "https://some.download.link" |
| status string | The status of the request. | "completed" |
| data_points_count integer | The number of data points used. | 1779429 |
Failed Response
This response object will be shown when the request is completed but failed (either due to bad request or internal error).
| Property | Description | Example |
|---|---|---|
| status string | The status of the request. | "bad_request", "internal error" |