Get Statistics

Web Data

Coming soon

This endpoint is documented but not yet available in production. The contract below reflects the planned behavior. Reach out via support for early access or launch notification.

Retrieve aggregated extraction statistics for a given date range

GET
/v1/statistics

Authorization

ApiKeyAuth
X-Api-Key<token>

In: header

Query Parameters

start_date?|

Filter by start date (defaults to 30 days ago). The window covers at most 366 days, counted back from the end of end_date (a date-only end_date includes its whole day); an older start is moved up

end_date?|

Filter by end date (defaults to now); a later end date is moved back to now

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/statistics"
{
  "extraction_count": 0,
  "previous_period_extraction_count": 0,
  "success_rate": 0,
  "average_extraction_duration": 0,
  "period_tokens_used": 0,
  "requests": [
    {
      "date": "2019-08-24T14:15:22Z",
      "success_request_count": 0,
      "failed_request_count": 0
    }
  ],
  "tokens_used": [
    {
      "date": "2019-08-24T14:15:22Z",
      "tokens_used": 0
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true,
  "details": {}
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Was this page helpful?