Kantata Kantata OX Knowledge Base Release Notes Status Page

Insights Report Exports

This object allows you to manage scheduled exports of Insights reports from Kantata OX. An export of an 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.

Get Scheduled Report Exports

Returns details for all scheduled exports of an Insights report.

Responses
200

A list of objects have been retrieved.

Response Schema: application/json
Array
id
integer <int32>

The ID of a scheduled report export.

title
string

The name of a scheduled report export.

description
string

The description of a scheduled report export, if provided.

external_report_object_identifier
string

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

object

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

created_at
string <date-time>

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

object

Download the most recent successfully exported report.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/scheduled_jobs/insights_report_exports
Request samples
Response samples
application/json
[
  • {
    }
]

Create a new Scheduled Report Export

Create a new scheduled job. Set a schedule for an Insights report to be exported from Kantata OX to download later. You will need to write a script to download the report.

Request
Request Body schema: application/json
object
title
string

Give a name for the scheduled report export.

description
string

Give a description for the scheduled report export.

external_report_object_identifier
required
string

Enter the unique identifier of the report you want to export on a schedule. Each report has one. Use the Insights Report endpoint to get this identifier for the report you want to export.

required
object

A schedule for when you would like the report export to repeat, consisting of the cadence and start_time that you define.

Responses
200

object has been created.

Response Schema: application/json
id
integer <int32>

The ID of a scheduled report export.

title
string

The name of a scheduled report export.

description
string

The description of a scheduled report export, if provided.

external_report_object_identifier
string

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

object

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

created_at
string <date-time>

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

object

Download the most recent successfully exported report.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

post/scheduled_jobs/insights_report_exports
Request samples
application/json
{
  • "insights_report_export": {
    }
}
Response samples
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "external_report_object_identifier": "string",
  • "recurrence": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "latest_success": {
    }
}

Get Scheduled Report Export

Returns details for a single scheduled export of an Insights report.

Request
path Parameters
id
required
integer

The ID of the Model.

Responses
200

The object has been retrieved.

Response Schema: application/json
id
integer <int32>

The ID of a scheduled report export.

title
string

The name of a scheduled report export.

description
string

The description of a scheduled report export, if provided.

external_report_object_identifier
string

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

object

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

created_at
string <date-time>

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

object

Download the most recent successfully exported report.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/scheduled_jobs/insights_report_exports/{id}
Request samples
Response samples
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "external_report_object_identifier": "string",
  • "recurrence": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "latest_success": {
    }
}

Update a Scheduled Report Export

Make changes to an existing scheduled job.

Request
path Parameters
id
required
integer

The ID of the Model.

Request Body schema: application/json
object
title
string

Give a name for the scheduled report export.

description
string

Give a description for the scheduled report export.

external_report_object_identifier
string

Enter the unique identifier of the report you want to export on a schedule. Each report has one. Use the Insights Report endpoint to get this identifier for the report you want to export.

object

A schedule for when you would like the report export to repeat, consisting of the cadence and start_time that you define.

Responses
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/scheduled_jobs/insights_report_exports/{id}
Request samples
application/json
{
  • "insights_report_export": {
    }
}
Response samples
application/json
{
  • "errors": [
    ]
}

Delete an existing Scheduled Report Export

The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.

Request
path Parameters
id
required
integer

The ID of the Model.

Responses
204

object has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

delete/scheduled_jobs/insights_report_exports/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}

Get Latest Export

Returns the most recent Insights report that has been successfully and completely exported by a scheduled job. The response contains a URL to download the report, as well as a timestamp for when the data in the report was last updated, so you may determine if the report reflects current data.

In order to keep exported data secure, the URL returned in the response expires in 60 seconds. The URL expiration period is subject to change. If you do not initiate a download of the report before the link expires, you can send a new request to generate a new URL.

Exporting a report can take from seconds to 20 minutes, depending on the report size. Because export time varies, please send requests until the latest data is returned. If there are no previously exported reports yet, the response code and message will indicate this.

Because exported reports can be up to 10 GB, reports are downloaded in a compressed format (.gz) and must be decompressed in order to access the csv file.

        Please contact Support for additional questions, or to access this feature.
Request
path Parameters
insights_report_export_id
required
integer

The ID of the Insights report export.

Responses
200

A list of objects have been retrieved.

Response Schema: application/json
object

Download the most recent successfully exported report.

url
string

The URL to the most recent successful report export. Download the exported report within 60 seconds. The URL expiration period is subject to change. If you do not download the report within 60 seconds, you can send a new request to generate a new URL.

created_at
string <date-time>

Timestamp for when the most recent successful report export was completed.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/scheduled_jobs/insights_report_exports/{insights_report_export_id}/results/latest
Request samples
Response samples
application/json
{
  • "latest_success": {
    }
}