Report History

Get information about all the reports that were requested.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

PropertyDescriptionExample
report_id stringID of the requested report, as returned by the '/request-report' endpoint.
report_name stringName of the requested report."Example"
user_id stringID of the user."5545647"
state stringStatus of the report request, as returned by the '/request-report' endpoint."pending", "processing", "completed"
used_quota integerNumber of credits actually charged after the report was generated.3213
create_date stringDate the report was requested."2024-09-10 11:11:30"
table stringName of the table used."traffic_and_engagement", "site_conversion"
start_date stringStart date of the report data."2024-07"
end_date stringEnd date of the report data."2024-07"
delivery_method stringHow the report is delivered."download_link", "bucket_access", "snowflake"
granularity stringGranularity of data in the report."daily", "monthly", "yearly"
refunded booleanSpecifies if user was refunded for the request (in case of failure).true, false
retention_days integerNumber of days before the report is expired.30
Query Params
string

Optional. Filter by ID of the user.

string

Optional. Filter all the reports that were requested after this date.

string

Optional. Filter by status of the report request (processing, completed etc.)

string

Optional. Filter by ID of the requested report.

string

Optional. Number of items to return.

string

Optional. Offset index to get items from.

Headers
string

Your Similarweb API key.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json