Skip to main content
GET
Get a report

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <credential> using either a Clerk session JWT or a Clerk API key (ak_*). API keys may identify a user (user_*) or organization (org_*) principal and are generated in the Clerk Dashboard under API keys.

Path Parameters

id
string<cuid>
required

Query Parameters

recentExecutionsLimit
integer
Required range: 0 < x <= 200

Response

Report detail

id
string
required
organizationId
string
required
name
string
required
description
string
required
type
enum<string>
required
Available options:
PRIVATE,
PUBLIC,
TEMPLATE
teamId
string | null
required
metricId
string | null
required
groupBy
string | null
required
datePreset
enum<string> | null
required
Available options:
TRAILING_90_DAYS,
TRAILING_30_DAYS,
TRAILING_45_DAYS,
TRAILING_7_DAYS,
TRAILING_3_DAYS,
TRAILING_14_WEEKS,
MTD,
QTD,
YTD,
LAST_WEEK,
LAST_MONTH,
LAST_6_MONTHS,
LAST_12_MONTHS,
LAST_4_YEARS,
LAST_3_MONTHS,
LAST_INVOICE_MONTH,
null
startDate
string | null
required
endDate
string | null
required
conditions
object | null
required
currency
enum<string> | null
required
Available options:
USD,
EUR,
GBP,
CNY,
null
scopeId
string | null
required
scheduledPeriod
enum<string> | null
required
Available options:
DAILY,
WEEKDAYS,
WEEKLY,
MONTHLY,
null
scheduledWeekday
integer | null
required
scheduledFirstRunAt
string<date-time> | null
required
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
archivedAt
string<date-time> | null
required
lastRunAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
createdById
string
required
updatedById
string | null
required
createdBy
object
required
updatedBy
object | null
required
widgets
object[]
required
destinations
object[]
required
nextRunDate
string<date-time> | null
required
destinationCounts
object
lastRunHealth
enum<string>
Available options:
OK,
FAILED,
PARTIAL,
IN_PROGRESS,
NEVER_RUN
recentRuns
object[]
executions
object[]
Last modified on July 20, 2026