metrics

Fetch metrics for a Service

get/metrics/areas/{area_id}/services/{svc_id}/raw

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/metrics/areas/{area_id}/services/{svc_id}/raw
  • Auth: none declared

Path parameters

area_idstring required

Area ID or Area name can be used.

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Query parameters

metricsstring

Which metrics would you like returned? See the Metrics List endpoint for a list of available metrics. Specified using a comma separated list of metric "codenames".

periodstring

What time period should results be grouped into? For example: "1month", "1quarter", "1year"

latestboolean

If true, only the latest row for each metric will be returned. Useful for fetching metrics that may lag such as Mobile Downloads.

max_onlyboolean

If true, only return the "max" value, and do not include the "sum" values for each metric. Useful to simplify the output.

agostring

Specify time in the past, relative to now, to fetch results for. Eg: "14days", or "3months". Will return data at this relative time.

start_ymdstring

A date timestamp in the format YYYY-MM-DD. Query will be filtered to only show resources on or after the given date.

end_ymdstring

A date timestamp in the format YYYY-MM-DD. Query will be filtered to only show resources on or before the given date.

tag_namestring

The name of the tag you wish to filter on. Must be used with the tag_value option as well.

tag_valuestring

The value of the tag you wish to filter on. Must be used with the tag_name option as well.

accumulateboolean

If True, metrics will be accumulated in each period, to a rolling total.

own_app_onlyboolean

If True, only metrics for apps owned by the service are returned. Data from enterprise apps is not returned for these services.

mergeboolean

Should results be merged together into one datapoint?

csvboolean

If True, results will be returned as a CSV instead of JSON.

Response

200 OK

Changes

No recorded changes to this operation across all 1 revision of this API.