Get request analytics

OpenAPI contract

Method

GET

Path

/api/v1/analytics/requests

Security

jwtBearer (bearer) OR automationKey (bearer)

Response status

200 400 401 403 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Request analytics",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestAnalyticsResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

GET /api/v1/analytics/requests accepts a JWT or an nfy_ key with analytics:read. range is one of 7d, 30d (default), 90d, or 1y; granularity is hour (default) or day. groupBy is none (default), authType, method, statusClass, or apiKey.

The response contains time-ordered request-count buckets, each with a per-dimension breakdown when groupBy is set, success-rate and latency-percentile (p50/p90/p95/p99) points per bucket, range-wide totals, a groupBy-keyed breakdown ranked by count, and the ten most-called paths in the range.

For a custom period, supply both from and to as ISO-8601 instants. They override range, must be ordered, and may span at most 366 days. The same filters as the request log apply: search, comma-separated method and status, statusClass, wildcard path, apiKeyId, minLatencyMs, and maxLatencyMs. Charts, totals, and breakdowns all use the filtered period.

http

GET /api/v1/analytics/requests?range=30d&granularity=hour&groupBy=statusClass
Authorization: Bearer <access token>