cURL
curl --request GET \
--url https://api.tirdad.ai/v1/analytics/reports \
--header 'x-api-key: <api-key>'from tirdad_sdk import Tirdad
with Tirdad(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.analytics.list_analytics_reports()
# Handle response
print(res)import { Tirdad } from "@tirdad/sdk";
const tirdad = new Tirdad({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await tirdad.analytics.listAnalyticsReports();
console.log(result);
}
run();package main
import(
"context"
tirdad "github.com/tirdad-billing/go-sdk/v2"
"log"
)
func main() {
ctx := context.Background()
s := tirdad.New(
tirdad.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Analytics.ListAnalyticsReports(ctx)
if err != nil {
log.Fatal(err)
}
if res.ReportCatalogResponse != nil {
// handle response
}
}{
"items": [
{
"category": "billing",
"default_shape": "timeseries",
"description": "<string>",
"dimensions": [
{
"key": "<string>",
"label": "<string>"
}
],
"grains": [
"day"
],
"improvement": "higher",
"key": "<string>",
"kind": "flow",
"max_range_days": 123,
"name": "<string>",
"shapes": [
"timeseries"
],
"supports_compare": true,
"value_type": "money",
"variant_label": "<string>",
"variant_of": "<string>"
}
]
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Analytics
List financial reports
Returns the catalog of reports with their allowed shapes, dimensions and grains.
GET
/
analytics
/
reports
cURL
curl --request GET \
--url https://api.tirdad.ai/v1/analytics/reports \
--header 'x-api-key: <api-key>'from tirdad_sdk import Tirdad
with Tirdad(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.analytics.list_analytics_reports()
# Handle response
print(res)import { Tirdad } from "@tirdad/sdk";
const tirdad = new Tirdad({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await tirdad.analytics.listAnalyticsReports();
console.log(result);
}
run();package main
import(
"context"
tirdad "github.com/tirdad-billing/go-sdk/v2"
"log"
)
func main() {
ctx := context.Background()
s := tirdad.New(
tirdad.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Analytics.ListAnalyticsReports(ctx)
if err != nil {
log.Fatal(err)
}
if res.ReportCatalogResponse != nil {
// handle response
}
}{
"items": [
{
"category": "billing",
"default_shape": "timeseries",
"description": "<string>",
"dimensions": [
{
"key": "<string>",
"label": "<string>"
}
],
"grains": [
"day"
],
"improvement": "higher",
"key": "<string>",
"kind": "flow",
"max_range_days": 123,
"name": "<string>",
"shapes": [
"timeseries"
],
"supports_compare": true,
"value_type": "money",
"variant_label": "<string>",
"variant_of": "<string>"
}
]
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}