--- title: /usage/explain slug: amberflo-api/usageexplain docTags: createdAt: 2024-11-07T15:10:16.969Z --- { "id": "YNkbDnpE4NG4v5HUblrVX", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/usage/explain", "servers": [ { "url": "https://app.amberflo.io/usage/explain" } ], "name": "", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "usage.MeterAggregationMetadata.in", "schema": [ { "name": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "aggregation", "kind": "optional", "type": "string", "description": "Aggregation function. If not specified, the default is obtained from the associated meter definition.", "modelRef": "#/components/schemas/usage.AggregationType.in", "customType": "usage.AggregationType.in", "schema": [] }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.in", "customType": "common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] }, { "name": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] }, { "name": "groupBy", "kind": "optional", "type": "array", "description": "Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole.\n\nValid values are:\n- `customerId`\n- `customerName`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "take", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.Take.in", "customType": "usage.MeterAggregationMetadata.Take.in", "schema": [ { "name": "limit", "kind": "required", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "timeGroupingInterval", "kind": "optional", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage.\n\nOn the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.in", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.in", "schema": [] }, { "name": "valuesTimeGroupingInterval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.in", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.in", "schema": [] }, { "name": "rescaleFunction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunction.in", "customType": "com.amberflo.service.common.aggregation.RescaleFunction.in", "schema": [ { "name": "function", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunctionType.in", "customType": "com.amberflo.service.common.aggregation.RescaleFunctionType.in", "schema": [] }, { "name": "coefficient", "kind": "optional", "type": "number", "example": "" } ] } ], "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "usage.controller.metadata_query.MeterAggregationQueryPlan.out", "schema": [ { "name": "finalAggregationType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/usage.AggregationType.out", "customType": "usage.AggregationType.out", "schema": [] }, { "name": "finalGroupBy", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "finalTimeRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] }, { "name": "extendedBaseQuery", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.out", "customType": "usage.MeterAggregationMetadata.out", "schema": [ { "name": "account", "kind": "optional", "type": "string", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "aggregation", "kind": "optional", "type": "string", "description": "Aggregation function. If not specified, the default is obtained from the associated meter definition.", "modelRef": "#/components/schemas/usage.AggregationType.out", "customType": "usage.AggregationType.out", "schema": [] }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] }, { "name": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] }, { "name": "groupBy", "kind": "optional", "type": "array", "description": "Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole.\n\nValid values are:\n- `customerId`\n- `customerName`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "take", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.Take.out", "customType": "usage.MeterAggregationMetadata.Take.out", "schema": [ { "name": "limit", "kind": "required", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "timeGroupingInterval", "kind": "optional", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage.\n\nOn the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "valuesTimeGroupingInterval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "rescaleFunction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunction.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunction.out", "schema": [ { "name": "function", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunctionType.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunctionType.out", "schema": [] }, { "name": "coefficient", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "realTimeSourceQuery", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.out", "customType": "usage.MeterAggregationMetadata.out", "schema": [ { "name": "account", "kind": "optional", "type": "string", "example": "" }, { "name": "meterApiName", "kind": "required", "type": "string", "description": "`meterApiName` as defined in [Meter API](ref:post_meters).", "example": "" }, { "name": "aggregation", "kind": "optional", "type": "string", "description": "Aggregation function. If not specified, the default is obtained from the associated meter definition.", "modelRef": "#/components/schemas/usage.AggregationType.out", "customType": "usage.AggregationType.out", "schema": [] }, { "name": "timeRange", "kind": "required", "type": "object", "description": "Time period for which to compute the usage.", "modelRef": "#/components/schemas/common.TimeRange.out", "customType": "common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "required", "type": "integer", "description": "Start time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds).", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "End time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds). Defaults to \"now\".", "example": 0 } ] }, { "name": "filter", "kind": "optional", "type": "map", "description": "`where` clause for the usage query. Each entry is a dimension and a list of values to filter for.\",\n\nValid filters are:\n- `customerId`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).\n- `tags:`\n\nDifferent filters are combined using logical `AND` operator while different filter values for a given key are combined using logic `OR` operator.\n\nTags can be specified in filters using the prefix `tags:`. For example,\n\n1. `tags:stage = [prod, dev]` will filter usage by all customer having tag `stage.prod` **or** `stage.dev`\n2. `tags:stage = [prod], tags:region = [us-west]` will filter usage by customers having tags `stage.prod` **and** `region.us-west-2`.", "example": "", "customType": "map", "schema": [] }, { "name": "groupBy", "kind": "optional", "type": "array", "description": "Group the usage data by these dimensions. If unspecified or empty, data will be aggregated for the meter as a whole.\n\nValid values are:\n- `customerId`\n- `customerName`\n- Any dimension defined in for the meter, see the [Meter API](ref:post_meters).", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "take", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/usage.MeterAggregationMetadata.Take.out", "customType": "usage.MeterAggregationMetadata.Take.out", "schema": [ { "name": "limit", "kind": "required", "type": "integer", "example": 0 }, { "name": "isAscending", "kind": "optional", "type": "boolean", "example": "" } ] }, { "name": "timeGroupingInterval", "kind": "optional", "type": "string", "description": "A usage query returns a time series of statistics. This field specifies the granularity of the time buckets in this series.\n\nNotice that for aggregation types: `MIN`, `MAX`, `AVG` this field has a more delicate meaning.\n\nFor example, for `AVG` if this field value is an `HOUR`, then you get the hourly average usage value for each group and a breakdown of each hour usage.\n\nOn the other hand if this field is a `DAY` then you get the average of the total daily usage, with a breakdown of the total usage per day.\n", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "valuesTimeGroupingInterval", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.AggregationInterval.out", "customType": "com.amberflo.service.common.aggregation.AggregationInterval.out", "schema": [] }, { "name": "rescaleFunction", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunction.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunction.out", "schema": [ { "name": "function", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunctionType.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunctionType.out", "schema": [] }, { "name": "coefficient", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "realTimeSource", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/usage.controller.metadata_query.RealTimeSource.out", "customType": "usage.controller.metadata_query.RealTimeSource.out", "schema": [] }, { "name": "s3Uris", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "user", "kind": "optional", "type": "string", "example": "" }, { "name": "resourceProperties", "kind": "optional", "type": "array", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "finalRescale", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunction.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunction.out", "schema": [ { "name": "function", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.aggregation.RescaleFunctionType.out", "customType": "com.amberflo.service.common.aggregation.RescaleFunctionType.out", "schema": [] }, { "name": "coefficient", "kind": "optional", "type": "number", "example": "" } ] } ], "modelRef": "#/components/schemas/usage.controller.metadata_query.MeterAggregationQueryPlan.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "K-jOv48d73TiwfYvGjbCF", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/usage/explain \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"meterApiName\": \"\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"take\": {\n \"limit\": 0\n }\n }'" }, { "id": "cjQyuC4aTJyVIs4F9G6Yw", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"meterApiName\": \"\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"take\": {\n \"limit\": 0\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/usage/explain\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "NcMd2vu2Pniz3KtEkWEwp", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/usage/explain\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"meterApiName\": \"\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"take\": {\n \"limit\": 0\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "QS1K4r60LeLh9OarZ7o11", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/usage/explain\"\n\npayload = json.dumps({\n \"meterApiName\": \"\",\n \"timeRange\": {\n \"startTimeInSeconds\": 0\n },\n \"take\": {\n \"limit\": 0\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "K-jOv48d73TiwfYvGjbCF" }, "results": { "languages": [ { "id": "MB5n7nZBRL9wgXBH2FvmG", "language": "200", "code": "// Successful request\n{\n \"finalAggregationType\": \"\",\n \"finalGroupBy\": [\n \"\"\n ],\n \"finalTimeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"extendedBaseQuery\": {\n \"account\": \"\",\n \"meterApiName\": \"\",\n \"aggregation\": \"\",\n \"timeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"filter\": \"\",\n \"groupBy\": [\n \"\"\n ],\n \"take\": {\n \"limit\": \"\",\n \"isAscending\": false\n },\n \"timeGroupingInterval\": \"\",\n \"valuesTimeGroupingInterval\": \"\",\n \"rescaleFunction\": {\n \"function\": \"\",\n \"coefficient\": 0\n }\n },\n \"realTimeSourceQuery\": {\n \"account\": \"\",\n \"meterApiName\": \"\",\n \"aggregation\": \"\",\n \"timeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"filter\": \"\",\n \"groupBy\": [\n \"\"\n ],\n \"take\": {\n \"limit\": \"\",\n \"isAscending\": false\n },\n \"timeGroupingInterval\": \"\",\n \"valuesTimeGroupingInterval\": \"\",\n \"rescaleFunction\": {\n \"function\": \"\",\n \"coefficient\": 0\n }\n },\n \"realTimeSource\": \"\",\n \"s3Uris\": [\n \"\"\n ],\n \"user\": \"\",\n \"resourceProperties\": [\n \"\"\n ],\n \"finalRescale\": {\n \"function\": \"\",\n \"coefficient\": 0\n }\n}" } ], "selectedLanguageId": "MB5n7nZBRL9wgXBH2FvmG" } }, "children": [ { "text": "" } ] }