v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Report History

Get information about all the reports that were requested.

get/v3/batch/reports/history

Query parameters

user_idstring

Optional. Filter by ID of the user.

start_datestring

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

statestring

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

report_idstring

Optional. Filter by ID of the requested report.

limitstring

Optional. Number of items to return.

offsetstring

Optional. Offset index to get items from.

Headers

api_keystring

Your Similarweb API key.

Response

200

totalinteger

Example response

{
  "items": [
    {
      "account_id": "111111111",
      "create_date": "2024-09-10 11:11:30",
      "credits_charged": "70",
      "delivery_method": "download_link",
      "end_date": "2024-07",
      "granularity": "monthly",
      "last_updated": "2024-09-10 11:13:09",
      "processing_start_time": "2024-09-10 11:12:15",
      "product": "BulkApi",
      "report_id": "3fb02526-d2cb-455688cf-7a99456fb874",
      "report_name": "Example",
      "retention_days": 30,
      "source": "batch_api",
      "start_date": "2024-07",
      "state": "completed",
      "table": "channel_conversion",
      "user_id": "5545647"
    }
  ],
  "total": 18399
}