Get usage details for an organization | Tigris Object Storage Documentation
Get usage details for an organization
GET https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/usage
Returns the usage details for the specified period. The usage details will include all the billable metrics for the period.
Request
Path Parameters
provider_id string required
Provider ID
org_id string required
Organization ID
Query Parameters
starting_on string required
RFC3339 formatted UTC midnight timestamp for starting period
Example: 2021-09-01T00:00:00Z
ending_before string required
RFC3339 formatted UTC midnight timestamp for ending period
Example: 2021-09-01T00:00:00Z
Responses
- 200
- default
OK
application/json
Schema
Example (auto)
Schema
data object[]
Array [
id string required
Unique identifier for the usage metric
name string required
Display name for customer invoice
description string required
Human readable description of the usage metric
unit string required
Unit of measurement
values object[] required
Array [
starting_on date-time required
RFC3339 formatted UTC timestamp for starting period
Example: 2021-09-01T01:00:00Z
ending_before date-time required
RFC3339 formatted UTC timestamp for ending period
Example: 2021-09-01T02:00:00Z
value double required
Usage value for the period
]
]
{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"unit": "string",
"values": [
{
"starting_on": "2021-09-01T01:00:00Z",
"ending_before": "2021-09-01T02:00:00Z",
"value": 0
}
]
}
]
}
Unexpected error
application/json
Schema
Example (auto)
Schema
message string
{
"message": "string"
}
Authorization: X-Tigris-Signature
name: X-Tigris-Signature
type: apiKey
in: header
description: HMAC-SHA256 of the canonical request signed using the signing key.
To create the signature, concatenate the HTTP method, URL, timestamp, and nonce with a newline character in between.
Then, calculate the HMAC-SHA256 of the concatenated string using the signing key. Example:
Create the `canonical_request` as:
POST https://mgmt.storage.dev/provider/your-provider-id/orgs/user-org-id/provision 1731703213870 f8d133cb-5a42-47b1-9ef2-874bb55bab72
Then, calculate HMAC-SHA256 of the canonical request using the signing key as:
Signature = hex(sha256sign(canonical_request, "signing_key"))
name: X-Tigris-Nonce
type: apiKey
in: header
description: Random unique string to identify the request and prevent replay attacks. Example: "f8d133cb-5a42-47b1-9ef2-874bb55bab72"
name: X-Tigris-Time
type: apiKey
in: header
description: Unix timestamp in milliseconds of the request. Example: 1731703213870
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- postman-cli
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://mgmt.storage.dev/v1/providers/:provider_id/orgs/:org_id/usage");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Tigris-Signature", "<X-Tigris-Signature>");
request.Headers.Add("X-Tigris-Nonce", "<X-Tigris-Nonce>");
request.Headers.Add("X-Tigris-Time", "<X-Tigris-Time>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());