Bulk Campaigns Download API (Early Access)

BalkanID Campaigns Download CSV Format

In this section, we will explain the BalkanID Campaigns CSV format.

Sample CSV

ID*	Name*	Description	Status*	Start Date*	End Date*	Percentage Completed*	Is Published*	Recurrence*	Escalation*	Escalation Date*
01HA02WD9PGPJA5FV4CNGYGGNM	Test campaign 3	Some random campaign	draft	2023-09-06	2023-09-20	0.00	FALSE
01HA02TFB8JBSF2BWBJBWVP696	Test Campaign 2	This is a campaign description	completed	2023-09-06	2023-09-22	100.00	TRUE
01HA02R3KH676CD9XHZAY8SCDZ	Test campaign	This is a test campaign	pending	2023-09-07	2023-09-26	35.24	FALSE	RRULE:FREQ=MONTHLY;INTERVAL=1;BYDAY=+1MO	168h	2024-05-23

NOTE: Columns with * are required always.

Column Definitions

Column name	Column Description
ID	Required - This is a unique campaign ID for each campaign generated by the BalkanID processing engine and serves as an identifier for each campaign
Name	Required - This is the name of the campaign
Description	Optional - This is the description of the campaign
Status	Required - The can be pending, draft, etc. depending on the status
Start Date	Required - The start date of the campaign - The date is in the YYYY-MM-DD format
End Date	Required - The end date of the campaign - The date is in the YYYY-MM-DD format
Percentage Completed	Required - Percentage of reviews completed which belongs to that campaign
Is Published	Required - Whether the campaign is published or not
Recurrence	Optional - The recurrence rule for the campaign
Escalation	Optional - The escalation time for the campaign
Escalation Date	Optional - The escalation date from which the escalation time is calculated

Download the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains is to download the CSV in BalkanID Campaigns CSV format from the pre-signed URL.
To use the polling URL, first send an HTTP request with the method HEAD to the pollingUrl.
If the response status code is 404, the file is not ready, and you should retry this polling request after a delay.
If the response status code is 200, the file is ready, and you may proceed to download the CSV from the received url.

Request

Header Params

X-Api-Key-ID

string

optional

X-Api-Key-Secret

string

optional

Content-Type

string

optional

Default:

application/json

Body Params application/json

includeCompleted

boolean

required

Include completed campaigns in the download.

includeDraft

boolean

required

Include draft campaigns in the download.

Example

{
    "includeCompleted": true,
    "includeDraft": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

download url response

Body

Download URL endpoint response

pollingUrl

string

required

The value is the polling URL which you will use to poll to find if the data is ready for download.

url

string

required

The value is the download URL from which you will download your CSV file.

Example

{
    "pollingUrl": "string",
    "url": "string"
}

🔴500Server Error

Bulk Campaigns Download API (Early Access)

BalkanID Campaigns Download CSV Format#

Column Definitions#

Download the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Campaigns Download CSV Format

Column Definitions

Download the CSV file via the pre-signed URL