Skip to main content
GET
/
reports
C#
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
Example:

20

​
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.

​
limit
integer
default:20

The number of items for this page.

Required range: 1 <= x <= 100
Example:

20

​
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"