Retrieve metrics

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

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

curl

cURL

curl --request GET \
  --url https://status.algolia.com/1/infrastructure/%2A/period/week \
  --header 'accept: application/json'

200

{
  "metrics": {
    "cpu_usage": {
      "s4-fr": [
        {
          "t": 1455101280,
          "v": 46
        },
        {
          "t": 1455101290,
          "v": 46
        },
        {
          "t": 1455101300,
          "v": 46
        }
      ],
      "c3-use-1": [
        {
          "t": 1455101280,
          "v": 42
        },
        {
          "t": 1455101290,
          "v": 42
        },
        {
          "t": 1455101300,
          "v": 42
        },
        {
          "t": 1455101310,
          "v": 37
        }
      ],
      "c3-use-2": [
        {
          "t": 1455101280,
          "v": 56
        },
        {
          "t": 1455101290,
          "v": 56
        },
        {
          "t": 1455101300,
          "v": 56
        },
        {
          "t": 1455101310,
          "v": 56
        },
        {
          "t": 1455101320,
          "v": 51
        }
      ]
    }
  }
}

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).

Path Parameters

metric · enum<string> · required

Metric to report.

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

Available options: avg_build_time, ssd_usage, ram_search_usage, ram_indexing_usage, cpu_usage, *

Example:

"*"

period · enum<string> · required

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.

Available options: minute, hour, day, week, month

Example:

"week"

Response

200

application/json

OK

metrics · metrics · object

Show child attributes