Statistics

Get Statistics

Retrieve aggregated extraction statistics for a date range.

GET /v1/statistics returns aggregate extraction metrics for the authenticated API key. Use it for dashboards, internal reporting, or lightweight usage checks from your own tooling.

If you omit the date filters, the API uses the last 30 days as the default range.

Request

The example below asks for statistics between two ISO date-time values. Run it from a terminal after setting your API key.

export SCRAPER_API_BASE_URL="https://scraper.geonode.io"
export GEONODE_SCRAPER_API_KEY="YOUR_API_KEY"

curl "$SCRAPER_API_BASE_URL/v1/statistics?start_date=2026-05-01T00:00:00Z&end_date=2026-05-27T00:00:00Z" \
  -H "X-Api-Key: $GEONODE_SCRAPER_API_KEY"

Query Parameters

Both query parameters are optional. Use them when you want a specific reporting window instead of the default 30-day range.

ParameterTypeRequiredDefaultDescription
start_datedate-timeNo30 days before the requestStart of the reporting period.
end_datedate-timeNoCurrent timeEnd of the reporting period.

Use ISO 8601 date-time strings, such as 2026-05-01T00:00:00Z.

Response

A successful request returns 200 with summary values and daily breakdown arrays.

{
  "extraction_count": 245,
  "previous_period_extraction_count": 198,
  "success_rate": 0.97,
  "average_extraction_duration": 842,
  "period_tokens_used": 245,
  "requests": [
    {
      "date": "2026-05-01T00:00:00Z",
      "success_request_count": 38,
      "failed_request_count": 2
    }
  ],
  "tokens_used": [
    {
      "date": "2026-05-01T00:00:00Z",
      "tokens_used": 40
    }
  ]
}
FieldDescription
extraction_countTotal extractions in the selected period.
previous_period_extraction_countTotal extractions in the previous period of the same length.
success_rateExtraction success rate as a value from 0.0 to 1.0.
average_extraction_durationAverage extraction duration in milliseconds.
period_tokens_usedTotal usage value reported by the API schema for the selected period. In billing language, treat this as request-count usage.
requestsDaily successful and failed request counts.
tokens_usedDaily usage values reported by the API schema.

On this page