Skip to main content

v0/endpoints/{id}/metrics REST API Endpoint

Returns a single metric.

Updated on
Sep 27, 2024

v0/endpoints/{id}/metrics REST API Endpoint

Path Parameters

id
string
REQUIRED
The unique identifier for the specific endpoint

Query Parameters

period
string
REQUIRED
Specifies the time period for which the data is to be retrieved. Valid values includes - hour, day, week or month
metric
string
REQUIRED
Specifies the type of metric to retrieve. Valid values includes - method_calls_over_time, response_status_over_time, method_call_breakdown, response_status_breakdown or method_response_time_max

Returns

data
array
An array of data
data
array
A nested list of numerical values representing the metric fetched for the endpoint
tag
string
A string label that identifies or categorizes the specific metric
error
string
A string containing an error message if the request to fetch the metric fails
Request
1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/endpoints/{id}/metrics?period=hour&metric=method_calls_over_time' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free