Skip to content

Gets project's usage api counts

get/v1/projects/{ref}/analytics/endpoints/usage.api-counts

The fine-grained token must include the following permissions to access this endpoint:

  • analytics_usage_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • interval
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"result": [
{
"timestamp": "4404-02-29T04:24Z",
"total_auth_requests": 42,
"total_realtime_requests": 42,
"total_rest_requests": 42,
"total_storage_requests": 42
}
],
"error": "lorem"
}
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|))$"
},
"total_auth_requests": {
"type": "number"
},
"total_realtime_requests": {
"type": "number"
},
"total_rest_requests": {
"type": "number"
},
"total_storage_requests": {
"type": "number"
}
},
"required": [
"timestamp",
"total_auth_requests",
"total_realtime_requests",
"total_rest_requests",
"total_storage_requests"
]
}
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"code": {
"type": "number"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"location": {
"type": "string"
},
"locationType": {
"type": "string"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"domain",
"location",
"locationType",
"message",
"reason"
]
}
},
"message": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"code",
"errors",
"message",
"status"
]
}
]
}
}
}