Skip to main content
GET
/
reports
/
{report_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Reports.GetAsync(reportId: "4d4c7123-b794-4fad-b1b9-5ab2606e6bbe");

// handle response
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_account_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "schedule": "daily",
  "schedule_enabled": true,
  "schedule_timezone": "<string>",
  "spec": {
    "model": "transactions",
    "params": {}
  },
  "type": "report",
  "creator_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "creator_display_name": "Jane Doe",
  "creator_type": "user",
  "next_execution_at": "2024-06-01T00:00:00.000Z",
  "description": "Monthly transaction summary for May 2024.",
  "latest_execution": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "dispatched",
    "context": {
      "reference_timestamp": "2023-11-07T05:31:56Z",
      "reference_timezone": "<string>"
    },
    "type": "report-execution"
  }
}
This endpoint requires the reports.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request. The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

​
report_id
string<uuid>
required

The ID of the report to retrieve details for. The ID of the report to retrieve details for.

Response

Successful Response

​
id
string<uuid>
required

The unique ID for the report.

​
merchant_account_id
string
required

The merchant account ID this report belongs to.

​
name
string
required

The name of the report.

Required string length: 1 - 100
​
created_at
string<date-time>
required

The date this report was created at.

​
updated_at
string<date-time>
required

The date this report was last updated.

​
schedule
enum<string>
required

The schedule for the report.

Available options:
daily,
monthly,
once,
weekly
​
schedule_enabled
boolean
required

Whether the report schedule is enabled.

​
schedule_timezone
string
required

The timezone for the report schedule.

​
spec
ReportSpec · object
required

The report specification.

​
type
string
default:report

Always report.

Allowed value: "report"
​
creator_id
string<uuid> | null

The ID of the user who created the report.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

​
creator_display_name
string | null

The display name of the report creator.

Required string length: 1 - 1000
Example:

"Jane Doe"

​
creator_type
enum<string> | null

The type of the report creator.

Available options:
user,
private_key
Example:

"user"

​
next_execution_at
string<date-time> | null

The next scheduled execution time for the report.

Example:

"2024-06-01T00:00:00.000Z"

​
description
string | null

A description of the report.

Required string length: 1 - 1000
Example:

"Monthly transaction summary for May 2024."

​
latest_execution
ReportExecutionSummary · object

The latest execution summary for the report.