Skip to content

Insights Report Exports

This object allows you to manage scheduled exports of classic Insights reports from Kantata OX. An export of a classic Insights report that is scheduled to recur is called a scheduled job. You can create, update, and delete scheduled jobs. You can also view details of all the exports for a scheduled job, view the details of each export individually, and download the most recently exported report.

To use these endpoints, you need to be an account administrator.

Operations

Get Scheduled Report Exports

Request

Returns a list of scheduled exports of classic Insights reports.

GET
/scheduled_jobs/insights_report_exports
curl -i -X GET \
  https://api.mavenlink.com/api/v1/scheduled_jobs/insights_report_exports

Responses

A list of Insights Report Exports have been retrieved.

Bodyapplication/json
Array [
idinteger, (int32)

The ID of a scheduled report export.

titlestring

The name of a scheduled report export.

descriptionstring

The description of a scheduled report export, if provided.

external_report_object_identifierstring

The unique identifier of the report you want to export on a schedule. Each report has one.

recurrenceobject

The schedule for when you would like the report export to repeat, defined by the cadence and start_time.

created_atstring, (date-time)

The timestamp for when an export of a report was completed.

latest_successobject

Download the most recent successfully exported report.

]
Response
[
  {
    "id": 0,
    "title": "string",
    "description": "string",
    "external_report_object_identifier": "string",
    "recurrence": {
      "cadence": "string",
      "start_time": "2019-08-24T14:15:22Z"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "latest_success": {
      "url": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  }
]