Skip to main content
GET
/
v1
/
analytics
/
mocks
/
dashboard
One-shot envelope of every mock analytics pipe
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/mocks/dashboard \
  --header 'x-api-key: <api-key>'
{
  "summary": [
    {
      "requests": 123,
      "matched_requests": 123,
      "errors": 123,
      "match_rate": 123,
      "error_rate": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123
    }
  ],
  "requests": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "requests": 123,
      "matched_requests": 123,
      "errors": 123
    }
  ],
  "latency": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "requests": 123,
      "avg_latency_ms": 123,
      "p50_latency_ms": 123,
      "p95_latency_ms": 123,
      "p99_latency_ms": 123
    }
  ],
  "match_rate": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "requests": 123,
      "matched_requests": 123,
      "match_rate": 123
    }
  ],
  "top_scenarios": [
    {
      "scenario_id": "<string>",
      "scenario_name": "<string>",
      "requests": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
granularity
string
default:hour
Pattern: ^(minute|hour|day|week)$
​
mock_id
string<uuid> | null
​
top_scenarios_limit
integer
default:10
Required range: 1 <= x <= 100
​
start_date
string<date>
required
​
end_date
string<date>
required

Response

Successful Response

​
summary
MockSummaryRow · object[]
required
​
requests
MockRequestsTimeseriesRow · object[]
required
​
latency
MockLatencyTimeseriesRow · object[]
required
​
match_rate
MockMatchRateTimeseriesRow · object[]
required
​
top_scenarios
MockTopScenarioRow · object[]
required