Geonode
API ReferenceGuidesScraper APIChange Log
Scraper apiGeneratedInternal statistics

Internal aggregated statistics

Returns aggregated extraction analytics across all users in the requested window. Intended for Geonode's internal team only; gated by INTERNAL_API_AUTH_* Basic Auth.

GET
/v1/internal/statistics

Authorization

X-Api-Key<token>

In: header

Query Parameters

from?string|null
to?string|null
granularity?string

Bucket size for the time-series breakdown.

Default"day"
Value in"day" | "week"
top_domains?integer

Maximum rows returned in the top-domains breakdown.

Default20
Range1 <= value <= 100
top_users?integer

Maximum rows returned in the top-users breakdown.

Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://scraper.geonode.io/v1/internal/statistics"
{
  "start_date": "2019-08-24T14:15:22Z",
  "end_date": "2019-08-24T14:15:22Z",
  "granularity": "day",
  "extraction_count": 0,
  "success_count": 0,
  "failed_count": 0,
  "success_rate": 0,
  "unique_users": 0,
  "average_extraction_duration_ms": 0,
  "tokens_used": 0,
  "firecrawl_fallback_count": 0,
  "firecrawl_fallback_rate": 0,
  "engine_mix": [
    {
      "engine": "string",
      "extraction_count": 0,
      "success_count": 0,
      "failed_count": 0,
      "share": 0,
      "success_rate": 0
    }
  ],
  "top_domains": [
    {
      "domain": "string",
      "extraction_count": 0,
      "success_count": 0,
      "failed_count": 0,
      "success_rate": 0
    }
  ],
  "top_users": [
    {
      "user_id": "string",
      "extraction_count": 0,
      "success_count": 0,
      "failed_count": 0,
      "success_rate": 0
    }
  ],
  "top_error_reasons": [
    {
      "category": "string",
      "error_code": "string",
      "count": 0,
      "share": 0
    }
  ],
  "by_plan": [
    {
      "plan_code": "string",
      "extraction_count": 0,
      "success_count": 0,
      "failed_count": 0,
      "success_rate": 0
    }
  ],
  "by_endpoint": [
    {
      "endpoint": "string",
      "extraction_count": 0,
      "success_count": 0,
      "failed_count": 0,
      "success_rate": 0
    }
  ],
  "billing_outcomes": {
    "committed": 0,
    "cancelled": 0,
    "expired": 0,
    "reserved": 0,
    "reserve_failed": 0,
    "settle_failed": 0,
    "settling": 0,
    "total": 0
  },
  "granular_breakdown": [
    {
      "bucket_start": "2019-08-24T14:15:22Z",
      "extraction_count": 0,
      "success_count": 0,
      "failed_count": 0,
      "tokens_used": 0
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}