Get Usage by Tag

Gets the aggregated usage information for a tag matching the name provided as a path parameter during a time period. The results will either have a singular item, or be an empty array.

GET /v2/usage/tags/{name}

Get Usage by Tag

cURL

curl --request GET \
  --url https://api.mezmo.com/v2/usage/tags/{name} \
  --header 'Authorization: <api-key>'

200

{
  "from": "<string>",
  "to": "<string>",
  "results": [
    {
      "name": "<string>",
      "total_bytes": 123
    }
  ]
}

Authorizations

AccessTokenservicekeyAuth

Authorization · string · header · required

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>'

Path Parameters

name · string · required

The name of the tag from which to get the aggregated usage data.

Query Parameters

from · string · required

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.

to · string · required

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.

retention · string

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

200

application/json

OK

from · string

The calculated starting time (exclusive) used internally.

to · string

The calculated ending time (exclusive) used internally.

results · object[]

Show child attributes