get/{tenantId}/v1/credit-reports/analytics

Get credit report analytics

Requires Authentication

Credit Reports

Returns analytics data for credit reports within the specified date range.

Includes summary statistics, daily breakdown, and status distribution.

Path Parameters

Name	Type	Description
`tenantId` required	`string (uuid)`	Tenant UUID

Query Parameters

Name	Type	Description
`dateFrom`	`string (date-time)`	Start date for analytics (ISO 8601 format). Defaults to 7 days ago.
`dateTo`	`string (date-time)`	End date for analytics (ISO 8601 format). Defaults to now.
`timeZone`	`string`	Timezone for day boundaries (e.g., "Europe/London"). Defaults to UTC.Default: `UTC`

Responses

Analytics data

Response Bodyapplication/json

summary

required

AnalyticsSummary

totalReports

integer (int64)

- Total number of credit reports in the date range

successRate

number (double)

- Percentage of reports with completed status (0-100)

totalPending

integer (int64)

- Number of reports with pending status

totalFailed

integer (int64)

- Number of reports with failed status

totalCompleted

integer (int64)

- Number of reports with completed status

dailyBreakdown

array

DailyBreakdown[]

required

DailyBreakdown

statusDistribution

array

StatusDistribution[]

required

StatusDistribution

dateFrom

string (date-time)

required

- Start of the analytics date range

dateTo

string (date-time)

required

- End of the analytics date range

Code Examples

curl -X GET 'https://api-next.checkio.co.uk/{tenantId}/v1/credit-reports/analytics' \
  -H 'Authorization: Bearer {token}'