List Usage by Tag

GET

https://api.mezmo.com/v2/usage/tags

GET

/v2/usage/tags

curl -G https://api.mezmo.com/v2/usage/tags \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     --data-urlencode from=2024-05-01T00:00:00Z \
     --data-urlencode to=2024-05-07T00:00:00Z \
     -d retention=7d \
     -d limit=10

{
  "from": "2024-05-01T00:00:00Z",
  "to": "2024-05-07T00:00:00Z",
  "results": [
    {
      "name": "payment-service.INFO",
      "total_bytes": 1250000
    },
    {
      "name": "auth-gateway.ERROR",
      "total_bytes": 450000
    },
    {
      "name": "order-processor.WARN",
      "total_bytes": 780000
    },
    {
      "name": "metrics-collector.request_latency_ms",
      "total_bytes": 320000
    },
    {
      "name": "logs.acme-corp.io.ERROR",
      "total_bytes": 210000
    },
    {
      "name": "telemetry.acme-corp.io.error_rate_5xx",
      "total_bytes": 150000
    }
  ]
}

Lists aggregated usage information for all tags during a time period.

Authentication

Authorizationstring

This key is used for all apis with the exception of ingest. You can obtain it following these instructions and placing the key in the header of your call in the format of Authorization: Token {accesstoken} For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

servicekeystring

(Deprecated) This key is used for v1 and v2 apis with the exception of ingest. Service keys can be used by placing your service key in the Authorization header of your api call. NOTE Usage of the service key auth mechanism has been deprecated in favor of IAM Access Tokens. Service keys can no longer be created, but can still be used for v1 and v2 apis while the transition takes place

Query parameters

fromstringRequired

Start time. A date-time string as defined by the ISO 8601 date format. This date-time will be used to calculate the starting day; the exact time will not be used.

tostringRequired

End time. A date-time string as defined by the ISO 8601 date format. This date-time will be used to calculate the ending day; the exact time will not be used.

limitintegerOptional

Maximum amount of tags to retrieve.

retentionstringOptional

Limit report to tags that contribute to a variable retention pool. Value must be a string indicating the retention pool duration, e.g. 7d for a seven day retention pool.

Response

fromstringOptional

The calculated starting time (exclusive) used internally.

tostringOptional

The calculated ending time (exclusive) used internally.

resultslist of objectsOptional

Errors

400

Bad Request Error