v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Report

Create report schedule

Create scheduled export for report

post/api/v1/analytics/report/{id}/schedule

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Request body

Example request

{
  "schedule": {
    "crontab": "0 0 * * *",
    "exportType": "email",
    "exportFormat": "csv",
    "emailList": [
      "email@xentral.com",
      "email1@xentral.com"
    ],
    "senderAccountId": 5
  }
}

Response

Report schedule response

Example response

{
  "data": [
    {
      "reportId": 1,
      "crontab": "0 0 * * *",
      "exportType": "email",
      "exportFormat": "txt",
      "emailList": [
        "email@xentral.com",
        "email1@xentral.com"
      ],
      "senderAccountId": 5,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "lastExecution": "2023-01-01T00:00:00+00:00",
      "nextExecution": "2023-01-01T00:00:00+00:00",
      "createdAt": "2023-01-01T00:00:00+00:00",
      "updatedAt": "2023-01-01T00:00:00+00:00",
      "reportTitle": "Sales Report"
    }
  ]
}