Account updater
Buyers - Payment methods
Payment methods
Payment methods - Payment service tokens
Payment methods - Network tokens
Buyers - Gift cards
Buyers - Shipping details
Card scheme definitions
Digital wallets - Setup
Digital wallets - Sessions
Transactions
Refunds
Payment options
Payment service definitions
Payment services
Audit logs
Reports - Executions
Checkout sessions
Merchant accounts
Reports
Get a report
Fetches a report by its ID.
GET
/
reports
/
{report_id}
curl --request GET \
--url https://api.{id}.gr4vy.app/reports/{report_id} \
--header 'Authorization: Bearer <token>'
{
"type": "report",
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"merchant_account_id": "merchant-account-12345",
"name": "Monthly Transaction Report",
"creator_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"creator_display_name": "Jane Doe",
"creator_type": "user",
"created_at": "2024-05-30T12:34:56.000Z",
"updated_at": "2024-05-30T13:00:00.000Z",
"next_execution_at": "2024-06-01T00:00:00.000Z",
"description": "Monthly transaction summary for May 2024.",
"schedule": "daily",
"schedule_enabled": true,
"schedule_timezone": "UTC",
"spec": {
"model": "transactions",
"params": {
"fields": [
"id",
"status"
],
"filters": {
"status": [
"succeeded"
]
}
}
},
"latest_execution": {
"type": "report-execution",
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"created_at": "2024-05-30T12:34:56.000Z",
"updated_at": "2024-05-30T13:00:00.000Z",
"status": "completed",
"context": {
"reference_timestamp": "2024-05-30T12:34:56.000Z",
"reference_timezone": "UTC"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The ID of the merchant account to use for this request.
Examples:
"default"
Path Parameters
The ID of the report to retrieve details for.
Examples:
"4d4c7123-b794-4fad-b1b9-5ab2606e6bbe"
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.{id}.gr4vy.app/reports/{report_id} \
--header 'Authorization: Bearer <token>'
{
"type": "report",
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"merchant_account_id": "merchant-account-12345",
"name": "Monthly Transaction Report",
"creator_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"creator_display_name": "Jane Doe",
"creator_type": "user",
"created_at": "2024-05-30T12:34:56.000Z",
"updated_at": "2024-05-30T13:00:00.000Z",
"next_execution_at": "2024-06-01T00:00:00.000Z",
"description": "Monthly transaction summary for May 2024.",
"schedule": "daily",
"schedule_enabled": true,
"schedule_timezone": "UTC",
"spec": {
"model": "transactions",
"params": {
"fields": [
"id",
"status"
],
"filters": {
"status": [
"succeeded"
]
}
}
},
"latest_execution": {
"type": "report-execution",
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"created_at": "2024-05-30T12:34:56.000Z",
"updated_at": "2024-05-30T13:00:00.000Z",
"status": "completed",
"context": {
"reference_timestamp": "2024-05-30T12:34:56.000Z",
"reference_timezone": "UTC"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.