GET /1/infrastructure/{metric}/period/{period}

Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.

Access to this API is available as part of the Premium or Elevate plans. You must authenticate requests with the x-algolia-application-id and x-algolia-api-key headers (using the Monitoring API key).

Servers

https://status.algolia.com

Path parameters

Name Type Required Description

Name	Type	Required	Description
`metric`	String	Yes	Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use ``. Possible values: `"cpu_usage"` `"ssd_usage"` `"ram_search_usage"` `""` `"avg_build_time"` `"ram_indexing_usage"`
`period`	String	Yes	Period over which to aggregate the metrics: `minute`. Aggregate the last minute. 1 data point per 10 seconds. `hour`. Aggregate the last hour. 1 data point per minute. `day`. Aggregate the last day. 1 data point per 10 minutes. `week`. Aggregate the last week. 1 data point per hour. `month`. Aggregate the last month. 1 data point per day. Possible values: `"month"` `"day"` `"minute"` `"week"` `"hour"`

metric

String

Yes

Metric to report.

For more information about the individual metrics, see the description of the API response. To include all metrics, use *.

Possible values:

"cpu_usage"
"ssd_usage"
"ram_search_usage"
"*"
"avg_build_time"
"ram_indexing_usage"

period

String

Yes

Period over which to aggregate the metrics:

minute. Aggregate the last minute. 1 data point per 10 seconds.
hour. Aggregate the last hour. 1 data point per minute.
day. Aggregate the last day. 1 data point per 10 minutes.
week. Aggregate the last week. 1 data point per hour.
month. Aggregate the last month. 1 data point per day.

Possible values:

"month"
"day"
"minute"
"week"
"hour"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy