Skip to main content
GET
Get all AI reports

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
title,
status,
created_at,
completed_at,
period_start,
period_end,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
status
enum<string> | null

Filter by report status.

Mevcut seçenekler:
pending,
running,
completed,
failed
format
enum<string> | null

Filter by report format. Distinguishes legacy stored HTML from template-rendered structured data.

Mevcut seçenekler:
html,
structured
period_label
enum<string> | null

Filter by report period. Persisted report windows mapped to the shared statistics period resolver.

Mevcut seçenekler:
today,
yesterday,
last_7_days,
last_30_days,
this_week,
this_month,
last_month,
this_year,
custom_date_range
user_id
integer | null

Filter by creator ID.

Gerekli aralık: x >= 1
systems[]
enum<string>[]

The report module.

Mevcut seçenekler:
appointment,
treatment,
room,
customer,
demographics,
customer_form,
revenue,
collections,
sale_items,
installments,
payment_methods,
lead,
pipeline,
offer,
lead_source,
chat,
channel,
blacklist,
ai_suggestion,
ticket,
low_stock,
stock_movement,
staff,
doctor_workload,
storage,
credits,
all
created_at_from
string<date-time> | null

Filter records created on or after this date.

created_at_to
string<date-time> | null

Filter records created on or before this date.

completed_at_from
string<date-time> | null

Filter records completed on or after this date.

completed_at_to
string<date-time> | null

Filter records completed on or before this date.

period_start_from
string<date-time> | null

Filter report periods starting on or after this date.

period_start_to
string<date-time> | null

Filter report periods starting on or before this date.

period_end_from
string<date-time> | null

Filter report periods ending on or after this date.

period_end_to
string<date-time> | null

Filter report periods ending on or before this date.

Yanıt

Paginated set of AIReportResource

data
AIReportResource · object[]
gerekli
meta
object
gerekli