One-shot envelope of every integration analytics pipe

GET

analytics

integrations

dashboard

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/integrations/dashboard \
  --header 'x-api-key: <api-key>'

{
  "summary": [
    {
      "current_invocations": 123,
      "previous_invocations": 123,
      "pct_change_invocations": 123,
      "current_failures": 123,
      "previous_failures": 123,
      "pct_change_failures": 123,
      "current_success_rate_pct": 123,
      "previous_success_rate_pct": 123,
      "pct_change_success_rate_pct": 123,
      "current_avg_latency_ms": 123,
      "previous_avg_latency_ms": 123,
      "pct_change_avg_latency_ms": 123,
      "current_p95_latency_ms": 123,
      "previous_p95_latency_ms": 123,
      "pct_change_p95_latency_ms": 123
    }
  ],
  "usage": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "invocations": 123,
      "successful": 123,
      "vendor_errors": 123,
      "exceptions": 123
    }
  ],
  "success_rate": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "invocations": 123,
      "successful": 123,
      "success_rate_pct": 123
    }
  ],
  "latency": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "invocations": 123,
      "p50_ms": 123,
      "p90_ms": 123,
      "p95_ms": 123,
      "p99_ms": 123,
      "avg_ms": 123,
      "max_ms": 123
    }
  ],
  "by_integration": [
    {
      "integration_key": "<string>",
      "invocations": 123,
      "successful": 123,
      "vendor_errors": 123,
      "exceptions": 123,
      "success_rate_pct": 123,
      "p95_latency_ms": 123
    }
  ],
  "by_mode": [
    {
      "mode": "<string>",
      "invocations": 123,
      "successful": 123,
      "vendor_errors": 123,
      "exceptions": 123,
      "success_rate_pct": 123,
      "p95_latency_ms": 123
    }
  ],
  "error_breakdown": [
    {
      "error_category": "<string>",
      "count": 123,
      "share_pct": 123
    }
  ]
}

Authorizations

x-api-key

string

header

required

Query Parameters

granularity

string

default:hour

Pattern: ^(minute|hour|day|week)$

integration_key

string | null

mode

string | null

slug

string | null

start_date

string<date>

required

end_date

string<date>

required

Response

Successful Response

Combined dashboard payload — one envelope, every integration panel.

summary is at most one row but the underlying pipe returns a list, so we keep it as a (possibly empty) list rather than special-casing it on the client.

summary

DashboardSummaryRow · object[]

required

Show child attributes

usage

InvocationsTimeseriesRow · object[]

required

Show child attributes

success_rate

SuccessRateTimeseriesRow · object[]

required

Show child attributes

latency

LatencyTimeseriesRow · object[]

required

Show child attributes

by_integration

InvocationsByIntegrationRow · object[]

required

Show child attributes

by_mode

InvocationsByModeRow · object[]

required

Show child attributes

error_breakdown

ErrorBreakdownRow · object[]

required

Show child attributes

Single-row connection-health summary: events, failures, success rate, latency

⌘I

One-shot envelope of every integration analytics pipe

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/integrations/dashboard \
  --header 'x-api-key: <api-key>'

{
  "summary": [
    {
      "current_invocations": 123,
      "previous_invocations": 123,
      "pct_change_invocations": 123,
      "current_failures": 123,
      "previous_failures": 123,
      "pct_change_failures": 123,
      "current_success_rate_pct": 123,
      "previous_success_rate_pct": 123,
      "pct_change_success_rate_pct": 123,
      "current_avg_latency_ms": 123,
      "previous_avg_latency_ms": 123,
      "pct_change_avg_latency_ms": 123,
      "current_p95_latency_ms": 123,
      "previous_p95_latency_ms": 123,
      "pct_change_p95_latency_ms": 123
    }
  ],
  "usage": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "invocations": 123,
      "successful": 123,
      "vendor_errors": 123,
      "exceptions": 123
    }
  ],
  "success_rate": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "invocations": 123,
      "successful": 123,
      "success_rate_pct": 123
    }
  ],
  "latency": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "invocations": 123,
      "p50_ms": 123,
      "p90_ms": 123,
      "p95_ms": 123,
      "p99_ms": 123,
      "avg_ms": 123,
      "max_ms": 123
    }
  ],
  "by_integration": [
    {
      "integration_key": "<string>",
      "invocations": 123,
      "successful": 123,
      "vendor_errors": 123,
      "exceptions": 123,
      "success_rate_pct": 123,
      "p95_latency_ms": 123
    }
  ],
  "by_mode": [
    {
      "mode": "<string>",
      "invocations": 123,
      "successful": 123,
      "vendor_errors": 123,
      "exceptions": 123,
      "success_rate_pct": 123,
      "p95_latency_ms": 123
    }
  ],
  "error_breakdown": [
    {
      "error_category": "<string>",
      "count": 123,
      "share_pct": 123
    }
  ]
}