HERE Cost Management Usage API v2

{"openapi":"3.0.2","info":{"version":"2.2.0","title":"Cost Management Usage API v2","description":"Provides API reference details for Usage API v2 which you can use to retrieve billable usage information. Usage billing rates are dependent on your licensing terms.","termsOfService":"https://developer.here.com/terms-conditions","license":{"name":"HERE Documentation License","url":"https://legal.here.com/en-gb/terms/documentation-license"}},"externalDocs":{"description":"The developer guide and release notes are available here.","url":"https://www.here.com/docs/category/cost-management"},"servers":[{"url":"https://usage.bam.api.here.com/v2","description":"Production server."}],"tags":[{"name":"Usage","description":"Usage"}],"paths":{"/usage/realms/{realmId}":{"get":{"tags":["Usage"],"summary":"Retrieve usage by organization","description":" This API retrieves the billable usage for your organization (realm). The realm ID is your organization ID.\n * Sort API response records alphabetically in ascending order by subscription ID, category, and charge item (name in the response), respectively.\n * The API supports usage by app ID.","operationId":"Cost Management Usage API v2 getUsageByRealm","parameters":[{"$ref":"#/components/parameters/Realm"},{"$ref":"#/components/parameters/StartDate"},{"$ref":"#/components/parameters/EndDate"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/AppIdQueryParam"},{"$ref":"#/components/parameters/ChannelIdQueryParam"},{"$ref":"#/components/parameters/ChargeTypeQueryParam"},{"$ref":"#/components/parameters/ProjectIdQueryParam"},{"$ref":"#/components/parameters/billingTagQueryParam"},{"$ref":"#/components/parameters/categoryQueryParam"},{"$ref":"#/components/parameters/billingSubscriptionIdQueryParam"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Detail"},{"$ref":"#/components/parameters/GroupBy"},{"$ref":"#/components/parameters/UsageFieldSet"},{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/xCorrelationId"}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePaginationResponse"},"examples":{"UsagePaginationResponseNoGroupBySummarizedDetail":{"value":{"total":10,"limit":2,"items":[{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactions","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","name":"Lane attributes","valueDriver":"GB","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByProjectAppBillingTagDayLevelDetail":{"value":{"total":10,"limit":2,"items":[{"realmId":"olp-here","projectHrn":"hrn:here:authorization::myrealm:project/my-project-0000","appId":"ew023asexaas14a1ps","billingTag":"testtag","featureId":"hrn:here:service::olp-here:search-geocoding-1","usageDateTime":"2020-01-01'T'00:00:00","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactions","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"projectHrn":"hrn:here:authorization::myrealm:project/my-project-0000","realmId":"olp-here","appId":"ew023asexaas14a1ps","billingTag":"testtag","usageDateTime":"2020-01-01'T'00:00:00","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","name":"Lane attributes","valueDriver":"GB","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByProjectAppBillingTagSummarizedDetail":{"value":{"total":10,"limit":2,"items":[{"appId":"ew023asexaas14a1ps","realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactions","projectHrn":"hrn:here:authorization::myrealm:project/my-project-0000","billingTag":"testtag","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"appId":"ew023asexaas14a1ps","realmId":"olp-here","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","name":"Lane attributes","valueDriver":"GB","projectHrn":"hrn:here:authorization::myrealm:project/my-project-0000","billingTag":"testtag1","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByProjectSummarizedDetail":{"value":{"total":10,"limit":2,"items":[{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactions","projectHrn":"hrn:here:authorization::myrealm:project/my-project-0000","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"realmId":"olp-here","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Lane attributes","valueDriver":"GB","projectHrn":"hrn:here:authorization::myrealm:project/my-project-0000","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByAppSummarizedDetail":{"value":{"total":10,"limit":2,"items":[{"appId":"ew023asexaas14a1ps","realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactions","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"appId":"ew023asexaas14a1ps","realmId":"olp-here","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","name":"Lane attributes","valueDriver":"GB","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByBillingTagSummarizedDetail":{"value":{"total":10,"limit":2,"items":[{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactiosn","billingTag":"testtag","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"realmId":"olp-here","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","billingTag":"testtag1","name":"Lane attributes","valueDriver":"GB","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByResourceSummarizedDetail":{"value":{"total":10,"limit":2,"items":[{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder Autosuggest","valueDriver":"Transactions","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"realmId":"olp-here","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","name":"Lane attributes","valueDriver":"GB","usageValue":"10","billableValue":"10","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}},"UsagePaginationResponseWithGroupByUsageTypeCodeSummarizedDetail":{"value":{"total":10,"limit":3,"items":[{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder","valueDriver":"Transactions","usageValue":"10","billableValue":"10","appId":"YQijV3hAPdxySAVtE6ZT","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"realmId":"olp-here","featureId":"hrn:here:service::olp-here:search-geocoding-1","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-00011212","category":"service","name":"Geocoder","valueDriver":"Transactions","usageValue":"10","billableValue":"10","appId":"YQijV3hAPdxySAVtE6ZT","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"},{"realmId":"olp-here","featureId":"featureHrn","billingSubscriptionId":"A-S00000021","billingChargeNumber":"C-0001124","category":"service","name":"Lane attributes","valueDriver":"GB","usageValue":"10","billableValue":"10","appId":"YQijV3hAPdxySAVtE6ZT","appName":"HERE Platform","appHrn":"hrn:here:account::HERE:app/YQijV3hAPdxySAVtE6ZT"}],"nextOffset":1,"lastOffset":4}}}}},"headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"token":[]}]}},"/usage/realms/{realmId}/csv":{"get":{"tags":["Usage"],"summary":"Retrieve usage CSV by organization","description":"This API retrieves the billable usage for your organization in CSV format.\n* Sort API response records alphabetically in ascending order by subscription ID, category, and the charge item (name in the response) respectively.\n* The API supports usage by app ID.","operationId":"Cost Management Usage API v2 getUsageCsvByRealm","parameters":[{"$ref":"#/components/parameters/Realm"},{"$ref":"#/components/parameters/StartDate"},{"$ref":"#/components/parameters/EndDate"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/AppIdQueryParam"},{"$ref":"#/components/parameters/ChannelIdQueryParam"},{"$ref":"#/components/parameters/ChargeTypeQueryParam"},{"$ref":"#/components/parameters/ProjectIdQueryParam"},{"$ref":"#/components/parameters/billingTagQueryParam"},{"$ref":"#/components/parameters/categoryQueryParam"},{"$ref":"#/components/parameters/billingSubscriptionIdQueryParam"},{"$ref":"#/components/parameters/Detail"},{"$ref":"#/components/parameters/GroupBy"},{"$ref":"#/components/parameters/UsageFieldSet"},{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/xCorrelationId"}],"responses":{"200":{"description":"Successful response.","content":{"text/csv":{"schema":{"type":"string","example":"Date and time (usageDateTime), Org ID (realmId), Category (category), App ID (appId), App Name (appName), App Hrn (appHrn), Item (featureId), Subscription ID (billingSubscriptionId), Item description (name), Unit (valueDriver), Project ID (projectHrn), Billing tag (billingTag), Usage Amount (billableValue)"}}},"headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"token":[]}]}},"/usage/realms/{realmId}/reports":{"post":{"summary":"Create usage reports for partner subaccounts","description":"  This is an Async API which generates usage reports for partner organizations or subaccounts. If the subaccounts aren't passed, then it only generates the partner organization usage report. If subaccounts pass to the request body, then the usage report consists of data for the subaccounts.\n  * API response has the current status of the request and also a header containing the URL for the \"get report status\" request.\n  * The API supports usage by app ID.","operationId":"Cost Management Usage API v2 createUsageReport","tags":["Usage"],"parameters":[{"$ref":"#/components/parameters/Realm"},{"$ref":"#/components/parameters/StartDate"},{"$ref":"#/components/parameters/EndDate"},{"$ref":"#/components/parameters/FeatureId"},{"$ref":"#/components/parameters/AppIdQueryParam"},{"$ref":"#/components/parameters/ChannelIdQueryParam"},{"$ref":"#/components/parameters/ChargeTypeQueryParam"},{"$ref":"#/components/parameters/ProjectIdQueryParam"},{"$ref":"#/components/parameters/billingTagQueryParam"},{"$ref":"#/components/parameters/categoryQueryParam"},{"$ref":"#/components/parameters/billingSubscriptionIdQueryParam"},{"$ref":"#/components/parameters/Detail"},{"$ref":"#/components/parameters/GroupBy"},{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/xCorrelationId"},{"$ref":"#/components/parameters/UsageFieldSet"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageReportRequest"}}}},"security":[{"token":[]}],"responses":{"201":{"description":"Generate usage report status request.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostUsageReportStatusResponse"},"examples":{"PostUsageReportStatusResponse":{"value":{"id":"REPORT-1007","status":"inProgress"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"get":{"summary":"Retrieve status for all usage report requests","description":"  The Async API retrieves the status of all usage report requests. The response contains the status of the usage report and the download URL.\n  * Sort API response records based on the created date in ascending or descending order, as the sort parameter in the API request.\n  * The API supports usage by app ID.","operationId":"Cost Management Usage API v2 getAllUsageReportRequestsStatus","tags":["Usage"],"parameters":[{"$ref":"#/components/parameters/Realm"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/xCorrelationId"}],"security":[{"token":[]}],"responses":{"200":{"description":"Retrieve the status for all usage report requests.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageReportStatusResponseList"},"examples":{"SuccessUsageReportStatusResponseList":{"value":{"total":18,"limit":5,"count":2,"nextOffset":0,"lastOffset":3,"items":[{"id":"REPORT-100","status":"inProgress","created":"2022-03-01'T'00:00:00","parameters":{"realm":"org1879256","startDate":"2022-03-01'T'00:00:00","endDate":"2022-07-01'T'00:00:00","chargeType":"all","emailId":"test_requester@here.com"}},{"id":"REPORT-145","status":"completed","resultHref":"https://usage/realms/org236848/report/REPORT-1475/output","created":"2022-04-01'T'00:00:00","parameters":{"realm":"org1879256","startDate":"2022-03-01'T'00:00:00","endDate":"2022-07-01'T'00:00:00","chargeType":"billable","emailId":"test_requester@here.com"}},{"id":"REPORT-167","status":"failed","created":"2022-08-01'T'00:00:00","parameters":{"realm":"org1879586","startDate":"2022-03-01'T'00:00:00","endDate":"2022-07-01'T'00:00:00","chargeType":"nonBillable","emailId":"test_requester2@here.com"}}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/usage/realms/{realmId}/reports/{reportId}":{"get":{"summary":"Retrieve status for a usage report request by ID","description":"  This API retrieves the status of a usage report request. The report creation Async API starts the report generation request and status, retrieving through this API. In the response of this API , You can identify the status of the usage report creation process and can download it when it has completed. The response contains the usage report download URL.\n  * API response has a single record having the status of the report request.\n  * The API supports usage by app ID.","operationId":"Cost Management Usage API v2 getUsageReportRequestStatus","tags":["Usage"],"parameters":[{"$ref":"#/components/parameters/Realm"},{"$ref":"#/components/parameters/ReportId"},{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/xCorrelationId"}],"security":[{"token":[]}],"responses":{"200":{"description":"Retrieve the usage report request status.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageReportStatusResponse"},"examples":{"InProgressUsageReportStatusResponse":{"value":{"id":"REPORT-1001","status":"inProgress","created":"2022-03-01'T'00:00:00","parameters":{"realm":"org1879256","startDate":"2022-03-01","endDate":"2022-07-01","emailId":"test_requester@here.com"}}},"CompletedUsageReportStatusResponse":{"value":{"id":"REPORT-1475","status":"completed","resultHref":"https://usage/realms/org236848/reports/REPORT-1475/output","created":"2022-04-01'T'00:00:00","parameters":{"realm":"org1879256","startDate":"2022-03-01","endDate":"2022-07-01","chargeType":"all","emailId":"test_requester@here.com"}}},"FailedUsageReportStatusResponse":{"value":{"id":"REPORT-1562","status":"failed","created":"2022-04-01'T'00:00:00","parameters":{"realm":"org1879656","startDate":"2022-06-01","endDate":"2022-07-01","emailId":"test_requester3@here.com"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/usage/realms/{realmId}/reports/{reportId}/output":{"get":{"summary":"Download a usage report","description":"  This API downloads the created usage report. \n  * The API responds with the usage report encoded in gzip format. \n  * The API supports usage by app ID.","operationId":"Cost Management Usage API v2 fetchCreatedReport","tags":["Usage"],"parameters":[{"$ref":"#/components/parameters/Realm"},{"$ref":"#/components/parameters/ReportId"},{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/xCorrelationId"}],"security":[{"token":[]}],"responses":{"200":{"description":"Successful response.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/x-gzip":{"schema":{"type":"string","format":"binary","description":"The usage report output is in gzip file format.","example":"REPORT-1583.csv.gz"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Get usage report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/health":{"get":{"summary":"Tests basic health of the service","operationId":"Cost Management Usage API v2 getHealth","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[{"token":[]}],"responses":{"200":{"description":"Health status of the service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiHealthStatus"}}},"headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}}}},"/version":{"get":{"summary":"Retrieves API version information","operationId":"Cost Management Usage API v2 getApiVersion","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[{"token":[]}],"responses":{"200":{"description":"Version of the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiVersion"}}},"headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}}}}},"components":{"examples":{"UnauthorizedErrorResponse":{"value":{"error":"Unauthorized","error_description":"No credentials found."}},"ForbiddenErrorResponse":{"value":{"error":"Forbidden","error_description":"These credentials do not provide authorized access."}},"InvalidRealm":{"value":{"title":"Input data failed validation","errorId":"ERROR-9d862c5a-4cfd-4780-8be4-2728b42849e1","status":400,"code":"E706001","cause":"Invalid Realm","action":"Correct input data and retry request","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74","details":{"title":"Invalid Realm {realm}","message":"Realm  {realm} has invalid characters."}}},"InvalidLimit":{"value":{"title":"Input data failed validation","errorId":"ERROR-22862c5a-4cfd-4780-8be4-2728b42de3j","status":400,"code":"E706002","cause":"Invalid Limit","action":"Correct input data and retry request","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74","details":{"title":"Invalid Limit.","message":"Limit value should not be greater than 100."}}},"InvalidDateRange":{"value":{"title":"Input data failed validation","errorId":"ERROR-22862c5a-4cfd-4780-8be4-2728b42de3j","status":400,"code":"E706003","cause":"start or end Date validation failed","action":"Correct input data and retry request","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74","details":{"title":"Invalid Start or end date.","message":"Invalid Start or end date."}}},"InvalidGroupBy":{"value":{"title":"Input data failed validation","errorId":"ERROR-22862c5a-4cfd-4780-8be4-2728b42de3j","status":400,"code":"E706004","cause":"Invalid group by field. Supported are appId, billingTag, and project","action":"Correct input data and retry request","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74","details":{"title":"Invalid group by field.","message":"Invalid group by field. Supported values are appId, billingTag, and project."}}}},"parameters":{"BillingTag":{"name":"billingTag","in":"query","required":true,"description":"Use billing tags to combine expenses from your invoices.","schema":{"type":"string","maxLength":256}},"FeatureId":{"name":"featureId","in":"query","required":false,"example":"hrn:here:service::olp-here:search-geocoding-1","description":"Identify features by feature HERE Resource Names (HRNs). Feature HRNs are necessary to acquire your usage using API requests.","schema":{"type":"string","maxLength":256}},"Project":{"name":"projectHrn","in":"query","required":true,"schema":{"type":"string","maxLength":256}},"AppId":{"name":"appId","in":"query","required":true,"schema":{"type":"string","maxLength":128}},"AppIdQueryParam":{"name":"appId","in":"query","required":false,"description":"Client app ID. This is the app ID created in the platform.","example":"j1dasda012edasfgne","schema":{"type":"string","maxLength":128,"pattern":"^[a-zA-Z0-9-_]*$"}},"ChannelIdQueryParam":{"name":"channelId","in":"query","required":false,"description":"When you provide this parameter, the results are filtered by the ID identifying the channel used for the usage reporting. A cold channel is a new billing data processing pipeline, whereas the hot channel is the old billing data processing pipeline. Use ChannelId for testing purposes.","example":"cold","schema":{"type":"string","enum":["hot","cold","ds"]}},"ChargeTypeQueryParam":{"name":"chargeType","in":"query","required":false,"description":"When this parameter is provided, the results are filtered by usages of a specific charge type.","example":"all","schema":{"type":"string","default":"all","enum":["all","billable","nonBillable"]}},"ProjectIdQueryParam":{"name":"projectHrn","in":"query","required":false,"description":"HRN identifying the project.","example":"hrn:here:authorization::myrealm:project/my-project-0000","schema":{"type":"string","maxLength":256}},"billingTagQueryParam":{"name":"billingTag","in":"query","required":false,"description":"Use billing tags for combining expenses from your invoices.","example":"testtag","schema":{"type":"string","maxLength":500}},"categoryQueryParam":{"name":"category","in":"query","required":false,"description":"The category is the name of the billable service you select, such as location services or pipelines.","example":"Pipelines","schema":{"type":"string","maxLength":128}},"billingSubscriptionIdQueryParam":{"name":"billingSubscriptionId","in":"query","required":false,"explode":false,"description":"A comma-separated list of billing subscription IDs, with a minimum of 1 item and a maximum of 20.","example":"A-S0000231,A-S0000233,A-S0000254","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":20}},"GroupBy":{"name":"groupBy","in":"query","required":false,"example":"appId, billingTag, project","description":"The groupBy parameter is a comma seperated list of parameters which you combine to form groups. Supported values are project, billingTag, appId, featureId, and subscription ID. The default groupBy parameters are featureId and subscription ID.\nWhen Add groupBy parameters in the query, so that they add to featureId and subscription ID.","schema":{"type":"string","maxLength":256}},"Realm":{"name":"realmId","in":"path","description":"Organization ID.","required":true,"example":"olp-here","schema":{"type":"string","minLength":5,"maxLength":30}},"ReportId":{"name":"reportId","in":"path","description":"Report ID.","required":true,"example":"REPORT-1346","schema":{"type":"string","minLength":11,"maxLength":30}},"ClientId":{"in":"path","name":"clientId","required":true,"schema":{"type":"string","example":"uIkGzYShLKtQQAimXzvV"},"description":"Identifier for the client/app, which must be present\nand active in your HERE account."},"EndDate":{"in":"query","name":"endDate","required":true,"schema":{"type":"string","format":"date-time","example":"yyyy-MM-dd'T'HH:mm:ss"},"description":"End date for search."},"Detail":{"in":"query","name":"detailLevel","required":false,"schema":{"type":"string","example":"hour","enum":["summarized","hour","day","month"]},"description":"You can use this query parameter to select one of the levels of detail to view in your usage records. Levels of detail include: summarized, hour, day, or month. \nThe summarized detail level is the default and shows you a summary of your usage."},"Offset":{"in":"query","name":"offset","required":false,"schema":{"type":"integer","minimum":0,"default":0},"description":"The offset page number determines the current page number in the search results view. The default value is zero."},"Sort":{"in":"query","name":"sort","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Returns sage report status in ascending or descending order of the creation date of the report."},"RequesterEmailId":{"in":"query","name":"emailId","required":true,"schema":{"type":"string"},"description":"This is your email ID"},"Limit":{"in":"query","name":"limit","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"description":"Returns the maximum number of records. The default and maximum is 100 records."},"PageToken":{"in":"query","name":"pageToken","required":false,"schema":{"type":"string"},"description":"If there are more records than the 'limit' (between 1 and 100), and there are multiple pages of records, 'pageToken' allows you to retrieve individual pages. To retrieve subsequent pages, the client must provide the pageToken returned in the result from the previous API call, and use this as input for the next API call.\nFor example, if the result for a call to GET /items returns *{..., \"pageToken\": \"abcdefg\"}*, to retrieve the next page of 'items', the client must call GET /items?pageToken=abcdefg."},"StartDate":{"in":"query","name":"startDate","required":true,"schema":{"type":"string","format":"date-time","example":"yyyy-MM-dd'T'HH:mm:ss"},"description":"Start date for search."},"UsageFieldSet":{"name":"usageFields","in":"query","required":false,"example":"realmId,featureId,category","description":"A set of unique and distinct usage field names which filter responses.","schema":{"type":"array","items":{"type":"string","enum":["realmId","featureId","billingSubscriptionId","billingChargeNumber","category","name","valueDriver","usageValue","billableValue","resource"]},"uniqueItems":true}},"xRequestId":{"name":"X-Request-ID","in":"header","description":"User-provided token used to trace a request or a group of requests sent to the service.","schema":{"type":"string"}},"xCorrelationId":{"name":"X-Correlation-ID","in":"header","required":true,"description":"Auto-generated ID, which uniquely identifies the request and is in the response. When contacting the support team with an inquiry regarding a specific request, provide the value of this header to assist with troubleshooting.\n","schema":{"type":"string"}}},"securitySchemes":{"token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A client access token must be obtained from a separate endpoint using the client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\n\nFor more information, see https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html.\n"}},"responses":{"BadRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"InvalidRealm":{"$ref":"#/components/examples/InvalidRealm"},"InvalidLimit":{"$ref":"#/components/examples/InvalidLimit"},"InvalidDateRange":{"$ref":"#/components/examples/InvalidDateRange"},"InvalidGroupBy":{"$ref":"#/components/examples/InvalidGroupBy"}}}},"description":"Invalid input provided, see error response for details.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"NotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"The requested resource was not found, see the error response for details.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"Unauthorized":{"description":"Access is denied due to invalid credentials.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/UnauthorizedErrorResponse"}}}}},"Forbidden":{"description":"You do not have permission to perform this action.","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/XCorrelationId"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/ForbiddenErrorResponse"}}}}}},"headers":{"X-Request-ID":{"description":"User provided token used to trace a request or a group of requests sent to the service.\n","schema":{"type":"string"}},"Location":{"required":false,"schema":{"type":"string"},"description":"The URL which polls the status for a request receiving a 202 response, such as ta/get/{clientId}?xCorrelationId=4199533b-6290-41db-8d79-edf4f4019a74."},"XCorrelationId":{"schema":{"type":"string"},"required":false,"description":"Correlates HTTP requests between a client and server. Sentry

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-cost-management-usage-v2-openapi.yml