PRODUCT
Follow

Resource URL

https://api.sizmek.com/rest/ReportBuilder/reports

Objects Used by This Resource

HTTP Method and URI List

HTTP Method

URI

Description

POST

/rest/ReportBuilder/reports/saveAndExecute

Create and run an ad-hoc report.

GET

/rest/ReportBuilder/reports/executions/{executionID}

Check status of a running ad-hoc report and get a download link.

POST

/rest/ReportBuilder/reports/saveAndActivate

Create and activate a scheduled report.

GET

/rest/ReportBuilder/reports/executions/download/{executionID}

Get a download link for a generated report.

GET

/rest/ReportBuilder/reports/executions?account={accountID}&templateId={reportID}&max=1

Retrieve the latest execution of a template.

DELETE

/rest/ReportBuilder/reports/{reportID}

Delete a report.

POST

/rest/ReportBuilder/reports

Save a report template without running the report.

PUT

/rest/ReportBuilder/reports

Update a previously saved report template.

PUT

/rest/ReportBuilder/reports/{reportID}/activate

Activate a previously saved schedule report.

PUT

/rest/ReportBuilder/reports/{reportID}/pause

Pause a scheduled report.

PUT

/rest/ReportBuilder/reports/{reportID}/resume

Resume a previously paused scheduled report.

PUT

/rest/ReportBuilder/reports/{reportID}/execute

Run a previously saved ad-hoc report.

Method Examples and Request Parameters

Important

Important:

  • For PUT calls, do the following:

    • We recommend that for any PUT method that updates an object, you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail.

    • You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:

       { "result": { "type": "Advertiser", ... } }      

      You should make the following modifications, including your specific modifications, to the json object that you submit for the request.

       { "entities": [{ "type": "Advertiser", ... }] }   
      
  • For POST calls, do the following:

    • Include the fields marked as Required, as indicated in the corresponding Object article.

    • Format the JSON object as follows:

       { "entities": [{ "type": "Advertiser", ... }] }   

Acquire Authorization Token

Every API user must provide a valid authorization token as a header to each request. For more information, see Authentication.

Note

Note; The response JSON includes the sessionId field. Extract it and include it in the header for all Analytics Report requests.

Create and Run an Ad-Hoc Report

Create and run the required ad-hoc report.

Request Parameters

Name

Description

Type

Required

Notes

body

Describes a whole report request with data that you want to see in it.

Report Object

Required

Currently, there is no support requests for multiple entities.

Request Format

POST https://api.sizmek.com/rest/ReportBuilder/reports/saveAndExecute

Response Format

Check Status of a Running Ad-Hoc Report and Get a Download Link

Verify the report execution and retrieve its status. If the report finishes successfully, you will also receive a URL in the response to download the report.

Request Format

GET https://api.sizmek.com/rest/ReportBuilder/reports/executions/{executionID}

Response Format

Get a Download Link for a Generated Report

Get a download link.

Request Format

GET https://api.sizmek.com/rest/ReportBuilder/reports/executions/download/{executionID}

Response Format

Retrieve the Latest Execution of a Template

Gets the latest execution of a report template.

Request Parameters

Name

Description

Type

Required

accountID

ID of the account to which the report belongs.

String

Required

reportID

ID of the report to be retrieved.

String

Required

Request Format

GET https://api.sizmek.com/rest/ReportBuilder/reports/executions?account={accountID}&templateId={reportID}&max=1

Response Format

Create and Activate a Scheduled Report

Create and schedule a report to run at a future time.

Request Parameters

Name

Description

Type

Required

Notes

body

Describes a whole report request with data that you want to see in it.

Report Object

Required

Request Format

POST https://api.sizmek.com/rest/ReportBuilder/reports/saveAndActivate

Response Format

Delete a Report

Deletes a scheduled report.

Request Parameters

Name

Description

Type

Required

reportID

ID of the report to be deleted.

String

Required

Request Format

DELETE https://api.sizmek.com/rest/ReportBuilder/reports/{reportID}

Response Format

A successful request returns the following code; the requested report is deleted.

Save a Report Template

Saves a report template without running the report; its scheduling status is INACTIVE.

Request Parameters

Name

Description

Type

Required

Notes

body

Describes a whole report request with data that you want to see in it.

Report Object

Required

Currently, there is no support requests for multiple entities.

Request Format

POST https://api.sizmek.com/rest/ReportBuilder/reports

Response Format

Update a Previously-Saved Report Template

Update a report template that was already saved.

Important

Important: In the Request body, you must provide the reportID for the report that you want to update.

Request Parameters

Name

Description

Type

Required

Notes

body

Describes a whole report request with data that you want to see in it.

Report Object

Required

Currently, there is no support requests for multiple entities.

Request Format

PUT https://api.sizmek.com/rest/ReportBuilder/reports

Response Format

Activate a Previously-Saved Scheduled Report

Activate a previously-saved schedule report. The scheduling status changes from INACTIVE to ACTIVE.

Request Parameters

Name

Description

Type

Required

reportID

ID of the report to be activated.

String

Required

Request Format

PUT https://api.sizmek.com/rest/ReportBuilder/reports/{reportID}/activate

Response Format

Pause a Scheduled Report

Pause a scheduled report. The scheduling status changes from ACTIVE to PAUSED.

Request Parameters

Name

Description

Type

Required

reportID

ID of the report to be paused.

String

Required

Request Format

PUT https://api.sizmek.com/rest/ReportBuilder/reports/{reportID}/pause

Response Format

Resume a Previously-Paused Scheduled Report

Resume a previously-paused scheduled report. The scheduling status changes from PAUSED to ACTIVE.

Request Parameters

Name

Description

Type

Required

reportID

ID of the report to be resumed.

String

Required

Request Format

PUT https://api.sizmek.com/rest/ReportBuilder/reports/{reportID}/resume

Response Format

Run a Previously-Saved Ad-Hoc Report

Run a previously-saved ad-hoc report.

Request Parameters

Name

Description

Type

Required

reportID

ID of the report to be run.

String

Required

Request Format

PUT https://api.sizmek.com/rest/ReportBuilder/reports/{reportID}/execute

Response Format

Status Codes and Errors

The following shows an example of an internal server error in a response body.

The following tables list the possible internal server errors for the Report resource.

General Errors

Code

Description

6001

Report field %s - %s.

API Report Validation Errors

Code

Description

6016

Execution is not ready for download.

6017

Execution ID, %s, does not exist.

6023

Report %s does not exist.

6024

Report field '%s' - %s.

6025

Report Attributes/Metrics does not support value of '%s'.

6026

"Report Scope does not support Attributes/Metrics value of '%s'.

6027

You cannot select Attributes/Metrics '%s' and '%s' in the same report.

6028

Unsupported %s.

6029

%s

6030

Either the custom field, %s, does not exist or there are insufficient privileges to use it.

6031

Custom field, %s, is not related to the selected account.

6032

Custom field, %s, is not allowed on level %s.

6033

Missing name for custom field '%s'.

6034

%s %s does not exist or insufficient privileges.

6035

User is not allowed to download report. Execution Id = %s

6036

You should be an owner of this report to see its execution status.

6300

Illegal value of '%s' param - %s.

6302

Primary attribution setting not supported. Please contact support.

6303

Original currency not supported. Please contact support.

Metadata Errors

Code

Description

6101

Invalid character, '%s', for report attribute or metric name.

6102

Report scope does not support attributes/metrics: '%s'.

6103

Attributes/metrics, '%s' and '%s', are not supported in the same report.

6104

Attributes/metrics, '%s', are not supported without one of the following: %s.

6105

Attributes/metrics, '%s', are only supported with the default Time Zone.

6106

Attributes/metrics, '%s', are not supported by the requested period breakdown.

6108

Attributes/metrics '%s' must have attribution settings that is not 0.

6108

Attributes/metrics '%s' currency settings should not be null.

6110

Attributes/metrics '%s' and '%s', are not supported in the same report.

6111

The following mandatory fields are missing: %s

6112

The following selected fields are not supported: %s

6113

All path events should be grouped together in a P2C report. The following path events found not grouped together: %s

Custom Fields Errors

Code

Description

6201

Either the custom field, %s, does not exist or there are insufficient permissions to use it.

6202

Custom field, %s, is not related to the selected account.

6203

Custom field, %s, is not allowed on level %s.

6204

Missing name for custom field '%s'.

6205

To pivot a report by %s, %s dimension must be selected.

Time Range Errors

Code

Description

6301

Unsupported report type.

6302

Start date cannot be before the End date.

6303

The scheduling interval is invalid because it is in the past.

6304

The cron expression does not fit the report date ranges.

6305

The cron expression structure is invalid.

6306

To show %s aggregation in your report, the date range should not be older than %s months.

6307

Report start date cannot be more than %s years from the current date.

6307

Reports with %s resolution can contain a maximum of %s days of data.

6307

Reports with %s resolution for dimensions - %s - can only contain a maximum of %s days of data.

6308

[%s] time zone is invalid when the start date is older than three months. Only the account time zone is permitted for selected date range.

6310

Period breakdown '%s' and time range '%s' combination is invalid for '%s' metrics group.

6311

Invalid combination for period breakdown '%s' and time range '%s'.

6312

Invalid period breakdown and start date combination. Reports that contain Unique metrics, with period breakdown %s, should start on %s.

6313

Invalid time zone %s for date range %s. Only the account time zone is permitted for the Campaign Lifetime date range.

6314

Invalid period breakdown and report dates combination. Reports that contain Unique metrics, with period breakdown %s, must be used with Campaign Lifetime.

6315

Period breakdown '%s' and time range '%s' combination is invalid.

6316

The selected time range is too large. The maximum supported time range is %s.

6317

The selected time range is invalid. Start Date is larger than End Date.

6318

Report start date is more than %s from the current date.

6319

Campaign Lifetime was not set for report scope '%s'.

6320

Unsupported execution type.

6321

Period breakdown '%s' and time range '%s' combination is invalid for '%s' attributes group.

Attribution Setting Errors

Code

Description

6407

The report start time cannot be before the effective date of the attribution model.

6408

The requested attribution model is invalid.

6409

The requested attribution model does not exist.

6410

Only the primary attribution model is available with the existing report settings.

6411

The requested metrics are not valid for the attribution model.

6413

You must provide at least one advertiser.

6414

You must provide at least one conversion metric.

6415

Unsupported PresetID : '%s'

6416

Campaign Lifetime is available only for the Primary attribution model.

6417

At least one metric from the '%s' group must be selected for the attribute '%s'.

Original Currency Errors

Code

Description

6501

The requested metrics or attributes, %s, are not valid for Original Currency.

6502

You must select at least one of the following fields with Original Currency: %s

6503

Original Currency cannot be used with selected metrics in the following groups: '%s'

6504

Original Currency only supported with Revenue.

Data Ownership Errors

Code

Description

6601

%s %s does not exist or there are insufficient permissions.

Filter Errors

Code

Description

6701

Filter '%s' for metrics, '%s', requires at least one of the following: %s

6702

Filter type, %s, contains too many items. Please select no more than %s items.

6703

The %s ID, %S, was not found in the %s filter output.

6704

Filter '%s' requires at least one of the following: %s

6705

Filters '%s' are not available with Delivery metrics.

Delivery Method Errors

Code

Description

6801

FTP error: Directory %s does not exist.

6802

FTP error: Authorization failed. user: %s, password: %s

6803

FTP error: Unknown hostname %s.

6804

SFTP error: Directory %s does not exist.

6805

SFTP error: Directory name, %s, is not valid.

6806

SFTP error: Connection error.

6807

SFTP error: There are no write permissions for directory %s.

6808

SFTP error: Unknown hostname %s.

6809

SFTP error: Authorization failed. user: %s, password: %s

HTTP Server Errors

Code

Description

6802

Could not run report [%s]. Report is %s.

6803

Could not activate report [%s]. Report is %s.

6804

Error occurred during report creation. Error cause: %s

6805

Could not update report [%s]. Received an exception.

6806

Could not resume the report [%s]. Report %s.

6807

Could not pause the report [%s[. Report %s.

6808

Could not pause or resume the %s report [reportID = %s ].

6809

Could not delete the report [reportID = %s].

6810

Unsupported operation for %s reports.

6811

Could not execute report [%s]. Received an exception.

6812

Could not activate report [%s]. Received an exception.

6813

Could not get report [%s]. Received an exception.

6814

Could not pause report [%s]. Received an exception.

6815

Could not resume report [%s]. Received an exception.

6816

Unable to retrieve saved reports based on account [%s] and user [%s].

6817

Error occurred when trying to retrieve executions.

6818

Error occurred when trying to generate links for executions. [Execution ID = %s]

6819

Error occurred when trying to pull execution details. [Execution ID = %s]

6820

Unable to retrieve saved reports based on account [%s].

6822

Could not stop the report [%s]. Report not active or paused.

6824

Unable to retrieve saved report based on account [%s] and user [%s].

6825

Error occurred when trying to retrieve sub executions related to execution ID [%s].

Currency Metadata Errors

Code

Description

6810

Currency type cannot be null.

6811

Currency type should be one of %s.

6812

Currency defaultCurrency field cannot be null.

6813

Currency defaultCurrency invalid value %s.

6814

Currency targetCurrency field cannot be null.

6815

Currency targetCurrency invalid value %s.

6816

Currency currencyExchangeDate field cannot be null.

Object Schema Errors

Code

Description

6900

Field %s value cannot be null.

6901

Field %s value cannot be %s.

Scope Errors

Code

Description

7001

Multiple accounts are not supported.

7002

You may select only advertisers or only campaigns.

7003

You may select only one advertiser or multiple campaigns under the same advertiser.

7004

You must provide one account.

7005

Account scope is not supported for this type of report.

Delimiter Errors

Code

Description

8001

The request does not include any delimiters.

8002

The unicode string provided is not valid.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk