Algolia Monitoring API (1.0.0)

Download OpenAPI specification:Download

The Monitoring API lets you check the status and performance of your Algolia infrastructure.

Note: The Monitoring API is available on Premium plans and plans including the Enterprise add-on.

Incidents

List the known incidents.

List incidents

List known incidents for all clusters.

Responses

Response samples

200
401

Content type

application/json

{"incidents": {"m134-de": [{"t": 1687441685000,
"v": {"title": "Incident on cluster m134-de: Everything operating normally.",
"status": "operational"
}
},
{"t": 1687441579000,
"v": {"title": "Incident on cluster m134-de: We are encountering a major issue that impact all API calls.",
"status": "major_outage"
}
}
]
}
}

List incidents for selected clusters

List known incidents for selected clusters.

path Parameters

clusters

required

string

Example: c1-de,c2-de,c3-de

Subset of clusters, separated by comma.

Responses

Response samples

200
401
404

Content type

application/json

{"incidents": {"m134-de": [{"t": 1687441685000,
"v": {"title": "Incident on cluster m134-de: Everything operating normally.",
"status": "operational"
}
},
{"t": 1687441579000,
"v": {"title": "Incident on cluster m134-de: We are encountering a major issue that impact all API calls.",
"status": "major_outage"
}
}
]
}
}

Infrastructure

Return information about the Algolia infrastructure used by your application.

Get metrics for a given period

Report the aggregate value of a metric for a selected period of time.

path Parameters

metric

required

string (Metric)

Enum: "avg_build_time" "ssd_usage" "ram_search_usage" "ram_indexing_usage" "cpu_usage" "*"

Example: *

Metric to report.

For more information about the individual metrics, see the response. To include all metrics, use * as the parameter.

period

required

string (Period)

Enum: "minute" "hour" "day" "week" "month"

Example: week

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.

Responses

Response samples

200
401

Content type

application/json

{"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
}
]
}
}
}

Monitoring

Report search and indexing times for your clusters, and get a list of servers.

List servers

List the servers belonging to clusters.

The response depends on whether you authenticate your API request:

With authentication, the response lists the servers assigned to your Algolia application's cluster.
Without authentication, the response lists the servers for all Algolia clusters.

Authorizations:

appIdapiKey

Responses

Response samples

200
403

Content type

application/json

{"inventory": [{"name": "c16-de-3",
"region": "de",
"is_slave": false,
"is_replica": false,
"cluster": "c16-de",
"status": "PRODUCTION",
"type": "cluster"
},
{"name": "c16-de-2",
"region": "de",
"is_slave": false,
"is_replica": false,
"cluster": "c16-de",
"status": "PRODUCTION",
"type": "cluster"
},
{"name": "c16-de-1",
"region": "de",
"is_slave": false,
"is_replica": false,
"cluster": "c16-de",
"status": "PRODUCTION",
"type": "cluster"
}
]
}

Get search latency times

List the average latency for search requests for selected clusters.

path Parameters

clusters

required

string

Example: c1-de,c2-de,c3-de

Subset of clusters, separated by comma.

Responses

Response samples

200
400

Content type

application/json

{"metrics": {"latency": {"c16-de": [{"t": 1688056200000,
"v": 64
},
{"t": 1688056800000,
"v": 59
},
{"t": 1688057400000,
"v": 55
}
]
}
}
}

Get indexing times

List the average times for indexing operations for selected clusters.

path Parameters

clusters

required

string

Example: c1-de,c2-de,c3-de

Subset of clusters, separated by comma.

Responses

Response samples

200
400

Content type

application/json

{"metrics": {"indexing": {"c16-de": [{"t": 1688056200000,
"v": 1562
},
{"t": 1688056800000,
"v": 1637
},
{"t": 1688057400000,
"v": 1754
}
]
}
}
}

Test the reachability of clusters

Test whether clusters are reachable or not.

path Parameters

clusters

required

string

Example: c1-de,c2-de,c3-de

Subset of clusters, separated by comma.

Responses

Response samples

200
400

Content type

application/json

{"c16-de": {"sdn-probe-frankfurt": false,
"monitoring-2": false,
"sdn-probe-awswest1": false
}
}

Status

Report the status of your clusters.

At Algolia, your application is hosted on a cluster with three servers.

Cluster names follow a pattern: c{[0-9]+}-{region} where {region} is one of the supported Algolia regions.

Server names follow the pattern: {cluster-name}-{1|2|3}.

List cluster statuses

Report whether clusters are operational.

The response depends on whether you authenticate your API request.

With authentication, the response includes the status of the cluster assigned to your Algolia application.
Without authentication, the response lists the statuses of all public Algolia clusters.

Authorizations:

appIdapiKey

Responses

Response samples

200
401

Content type

application/json

{"status": {"c16-de": "operational"
}
}

List statuses of selected clusters

Report whether a cluster is operational.

path Parameters

clusters

required

string

Example: c1-de,c2-de,c3-de

Subset of clusters, separated by comma.

Responses

Response samples

200
401
404

Content type

application/json

{"status": {"c16-de": "operational"
}
}

Send requests to the Algolia REST API

This method allow you to send requests to the Algolia REST API.

path Parameters

path

required

string

Example: /keys

Path of the endpoint, anything after "/1" must be specified.

query Parameters

object

Query parameters to apply to the current query.

Responses

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API

This method allow you to send requests to the Algolia REST API.

path Parameters

path

required

string

Example: /keys

Path of the endpoint, anything after "/1" must be specified.

query Parameters

object

Query parameters to apply to the current query.

Request Body schema: application/json

Parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API

This method allow you to send requests to the Algolia REST API.

path Parameters

path

required

string

Example: /keys

Path of the endpoint, anything after "/1" must be specified.

query Parameters

object

Query parameters to apply to the current query.

Request Body schema: application/json

Parameters to send with the custom request.

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
402
403
404

Content type

application/json

{ }

Send requests to the Algolia REST API

This method allow you to send requests to the Algolia REST API.

path Parameters

path

required

string

Example: /keys

Path of the endpoint, anything after "/1" must be specified.

query Parameters

object

Query parameters to apply to the current query.

Responses

Response samples

200
400
402
403
404

Content type

application/json

{ }