List configured reports

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

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

ListReportsRequest req = new ListReportsRequest() {};

ListReportsResponse? res = await sdk.Reports.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

{
  "items": [
    {
      "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"
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

GET

reports

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

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

ListReportsRequest req = new ListReportsRequest() {};

ListReportsResponse? res = await sdk.Reports.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

{
  "items": [
    {
      "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"
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

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.

Example:

"default"

Query Parameters

cursor

string | null

A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit

integer

default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100

schedule

enum<string>[] | null

Filters the reports by the type of schedule at which they run.

Available options:

daily,

monthly,

once,

weekly

Example:

["daily", "monthly"]

schedule_enabled

boolean | null

Filters the reports by wether their schedule is enabled.

Example:

true

name

string | null

Filters the reports by searching their name for (partial) matches.

Example:

"My report"

Response

Successful Response

items

Report · object[]

required

A list of items returned for this request.

Show child attributes

items.id

string<uuid>

required

The unique ID for the report.

items.merchant_account_id

string

required

The merchant account ID this report belongs to.

items.name

string

required

The name of the report.

Required string length: 1 - 100

items.created_at

string<date-time>

required

The date this report was created at.

items.updated_at

string<date-time>

required

The date this report was last updated.

items.schedule

enum<string>

required

The schedule for the report.

Available options:

daily,

monthly,

once,

weekly

items.schedule_enabled

boolean

required

Whether the report schedule is enabled.

items.schedule_timezone

string

required

The timezone for the report schedule.

items.spec

ReportSpec · object

required

The report specification.

Show child attributes

items.spec.model

enum<string>

required

The report model type.

Available options:

transactions,

transaction_retries,

detailed_settlement,

accounts_receivables

items.spec.params

Params · object

required

The parameters for the report model.

items.type

string

default:report

Always report.

Allowed value: "report"

items.creator_id

string<uuid> | null

The ID of the user who created the report.

Example:

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

items.creator_display_name

string | null

The display name of the report creator.

Required string length: 1 - 1000

Example:

"Jane Doe"

items.creator_type

enum<string> | null

The type of the report creator.

Available options:

user,

private_key

Example:

"user"

items.next_execution_at

string<date-time> | null

The next scheduled execution time for the report.

Example:

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

items.description

string | null

A description of the report.

Required string length: 1 - 1000

Example:

"Monthly transaction summary for May 2024."

items.latest_execution

ReportExecutionSummary · object

The latest execution summary for the report.

Show child attributes

items.latest_execution.id

string<uuid>

required

The unique ID for the report execution.

items.latest_execution.created_at

string<date-time>

required

The date this report execution was created at.

items.latest_execution.updated_at

string<date-time>

required

The date this report execution was last updated.

items.latest_execution.status

enum<string>

required

The status of the report execution.

Available options:

dispatched,

failed,

pending,

processing,

succeeded

items.latest_execution.context

ReportExecutionContext · object

required

The context for the report execution.

Show child attributes

items.latest_execution.context.reference_timestamp

string<date-time>

required

The reference timestamp for the report execution context.

items.latest_execution.context.reference_timezone

string

required

The reference timezone for the report execution context.

items.latest_execution.type

string

default:report-execution

Always report-execution.

Allowed value: "report-execution"

limit

integer

default:20

The number of items for this page.

Required range: 1 <= x <= 100

next_cursor

string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor

string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"

Update a merchant account

Get a report

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

Connections

Errors

Other

List configured reports

Authorizations

Headers

Query Parameters

Response