Navigation
VigilbaseDocs

    Type at least two letters.

    Open Vigilbase One
    Vigilbase One APIServices

    Get Cloudflare analytics dashboard

    GET /api/services/cloudflare/analytics/dashboard on the Vigilbase One API.

    GET/api/services/cloudflare/analytics/dashboard

    Authorizations

    Send one of these:

    AuthorizationstringAccess tokenheaderrequired

    Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login.

    AuthorizationstringAPI keyheaderrequired

    Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Read-only keys work. See organisation API keys.

    Permissions checkedread:services

    Query Parameters

    accountIdstring
    customerIdstring
    rangestring
    variantstring
    zoneIdstring

    Body

    application/json

    The catalog has no JSON Schema for this body. One validates it with the schema below.

    Validation schema
    QuerySchema = z.object({
  customerId: z.string().uuid('Invalid customer ID format'),
  zoneId: z.string().regex(CLOUDFLARE_ID, 'Invalid zone ID format').optional(),
  accountId: z.string().regex(CLOUDFLARE_ID, 'Invalid account ID format').optional(),
  range: z.enum(TRAFFIC_RANGES).default('24h'),
  variant: z.enum(['shield', 'enterprise']).optional(),
})

    Response

    Success

    Was this page helpful?