Reporting Service API

Auto-generated from NestJS controller decorators. Last synced: 2026-03-15

Base path: /api
Endpoints: 21

Customer Health

List customer health scores

GET/reporting/customers/healthBearer token

riskLevelstring

query parameter

limitnumber

query parameter

Get individual customer health score

GET/reporting/customers/:id/healthBearer token

idstringRequired

path parameter

Dashboard

Unified KPIs across all domains

GET/reporting/dashboard/kpisBearer token

Active alerts and anomalies

GET/reporting/dashboard/alertsBearer token

Exports

Create a new export job

POST/reporting/exportsBearer token

Request Body: reportType: string; format: string; parameters: Recordstring, unknown; startDate: string; endDate: string;

reportTypestringRequired

—

formatstringRequired

—

parametersRecordstring, unknownRequired

—

startDatestringRequired

—

endDatestringRequired

—

List export jobs

GET/reporting/exportsBearer token

limitstring

query parameter

Get export status

GET/reporting/exports/:idBearer token

idstringRequired

path parameter

Download exported file

GET/reporting/exports/:id/downloadBearer token

idstringRequired

path parameter

Focus

FOCUS-compliant cost and usage report

GET/reporting/focus/cost-and-usageBearer token

startDatestringRequired

query parameter

endDatestringRequired

query parameter

serviceCategorystring | string[]

query parameter

providerstring | string[]

query parameter

chargeCategorystring | string[]

query parameter

regionIdstring

query parameter

pagestring

query parameter

pageSizestring

query parameter

sortBystring

query parameter

sortOrder'ASC' | 'DESC'

query parameter

FOCUS cost and usage grouped by dimension

GET/reporting/focus/cost-and-usage/groupedBearer token

startDatestringRequired

query parameter

endDatestringRequired

query parameter

groupBystring | string[]Required

query parameter

serviceCategorystring | string[]

query parameter

providerstring | string[]

query parameter

Health

Liveness probe

GET/health

Readiness probe

GET/ready

Infrastructure

Resource utilization by provider and region

GET/reporting/infrastructure/utilizationBearer token

startDatestringRequired

query parameter

endDatestringRequired

query parameter

providerstring | string[]

query parameter

regionIdstring

query parameter

Provisioning Analytics

Provisioning SLA compliance and performance metrics

GET/reporting/provisioning/performanceBearer token

startDatestringRequired

query parameter

endDatestringRequired

query parameter

Revenue

MRR breakdown over time

GET/reporting/revenue/mrrBearer token

periodstringRequired

query parameter

startDatestringRequired

query parameter

endDatestringRequired

query parameter

Churn analysis over time

GET/reporting/revenue/churnBearer token

periodstringRequired

query parameter

startDatestringRequired

query parameter

endDatestringRequired

query parameter

Schedules

Create a scheduled report

POST/reporting/schedulesBearer token

Request Body: name: string; reportType: string; format: string; frequency: string; parameters: Recordstring, unknown; recipients: string[]; enabled: boolean;

namestringRequired

—

reportTypestringRequired

—

formatstringRequired

—

frequencystringRequired

—

parametersRecordstring, unknownRequired

—

recipientsstring[]Required

—

enabledbooleanRequired

—

List scheduled reports

GET/reporting/schedulesBearer token

Get schedule details

GET/reporting/schedules/:idBearer token

idstringRequired

path parameter

Update a scheduled report

PUT/reporting/schedules/:idBearer token

idstringRequired

path parameter

Request Body: UpdateScheduleOptions

namestring

—

formatstring

—

frequencystring

—

parametersRecordstring, unknown

—

recipientsstring[]

—

enabledboolean

—

Delete a scheduled report

DELETE/reporting/schedules/:idBearer token

idstringRequired

path parameter