using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;
var sdk = new Gr4vySDK(
id: "example",
server: SDKConfig.Server.Sandbox,
bearerAuthSource: Auth.WithToken(privateKey),
merchantAccountId: "default"
);
var res = await sdk.Reports.CreateAsync(reportCreate: new ReportCreate() {
Name = "Monthly Transaction Report",
Schedule = "<value>",
ScheduleEnabled = true,
ScheduleTimezone = "UTC",
Spec = Spec.CreateDetailedSettlement(
new DetailedSettlementReportSpec() {
Params = new Dictionary<string, object>() {
{ "filters", new Dictionary<string, object>() {
{ "ingested_at", new Dictionary<string, object>() {
{ "end", "day_end" },
{ "start", "day_start" },
} },
} },
},
}
),
});
// handle response
{
"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"
}
}
}
Create a new report.
using Gr4vy;
using Gr4vy.Models.Components;
using System.Collections.Generic;
var sdk = new Gr4vySDK(
id: "example",
server: SDKConfig.Server.Sandbox,
bearerAuthSource: Auth.WithToken(privateKey),
merchantAccountId: "default"
);
var res = await sdk.Reports.CreateAsync(reportCreate: new ReportCreate() {
Name = "Monthly Transaction Report",
Schedule = "<value>",
ScheduleEnabled = true,
ScheduleTimezone = "UTC",
Spec = Spec.CreateDetailedSettlement(
new DetailedSettlementReportSpec() {
Params = new Dictionary<string, object>() {
{ "filters", new Dictionary<string, object>() {
{ "ingested_at", new Dictionary<string, object>() {
{ "end", "day_end" },
{ "start", "day_start" },
} },
} },
},
}
),
});
// handle response
{
"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"
}
}
}
This endpoint requires the reports.write
scope.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The ID of the merchant account to use for this request.
"default"
Successful Response
The response is of type object
.
Was this page helpful?