Developer Hub
Request Demo
Request Demo
Support
  1. Campaigns
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
        POST
      • Bulk Campaigns Upload API (Early Access)
        POST
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
      • Bulk Entity Finding Rules Download API (Early Access)
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
      • Bulk Filters Download API (Early Access)
      • Bulk Filters Upload API (Early Access)
      • Bulk Findings Download API (Early Access)
      • Bulk Findings Upload API (Early Access)
      • Bulk Labels Download API (Early Access)
      • Bulk Labels Upload API (Early Access)
      • Bulk Privileged Download API (Early Access)
      • Bulk Privileged Upload API (Early Access)
      • Bulk RBAC Download API (Early Access)
      • Bulk RBAC Upload API (Early Access)
      • Bulk RBAC2 Download API (Early Access)
      • Bulk RBAC2 Upload API (Early Access)
      • Bulk Rules Download API (Early Access)
      • Bulk Rules Upload API (Early Access)
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
      • Bulk Entities Upload API (Early Access)
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
      • Bulk Requests Upload API (Early Access)
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
      • Bulk Webhook Templates API (Early Access)
  • Playbooks
    • Overview
  1. Campaigns

Bulk Campaigns Download API (Early Access)

POST
https://app.balkan.id/api/rest/v0/campaigns/download-url

BalkanID Campaigns Download CSV Format#

In this section, we will explain the BalkanID Campaigns CSV format.
Sample CSV
ID*Name*DescriptionStatus*Start Date*End Date*Percentage Completed*Is Published*Recurrence*Escalation*Escalation Date*
01HA02WD9PGPJA5FV4CNGYGGNMTest campaign 3Some random campaigndraft2023-09-062023-09-200.00FALSE
01HA02TFB8JBSF2BWBJBWVP696Test Campaign 2This is a campaign descriptioncompleted2023-09-062023-09-22100.00TRUE
01HA02R3KH676CD9XHZAY8SCDZTest campaignThis is a test campaignpending2023-09-072023-09-2635.24FALSERRULE:FREQ=MONTHLY;INTERVAL=1;BYDAY=+1MO168h2024-05-23
NOTE: Columns with * are required always.
Column Definitions#
Column nameColumn Description
IDRequired - This is a unique campaign ID for each campaign generated by the BalkanID processing engine and serves as an identifier for each campaign
NameRequired - This is the name of the campaign
DescriptionOptional - This is the description of the campaign
StatusRequired - The can be pending, draft, etc. depending on the status
Start DateRequired - The start date of the campaign - The date is in the YYYY-MM-DD format
End DateRequired - The end date of the campaign - The date is in the YYYY-MM-DD format
Percentage CompletedRequired - Percentage of reviews completed which belongs to that campaign
Is PublishedRequired - Whether the campaign is published or not
RecurrenceOptional - The recurrence rule for the campaign
EscalationOptional - The escalation time for the campaign
Escalation DateOptional - 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

Body Params application/json

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/campaigns/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "includeCompleted": true,
    "includeDraft": true
}'

Responses

🟢200OK
application/json
download url response
Body

Example
{
    "pollingUrl": "string",
    "url": "string"
}
🔴500Server Error
Modified at 2025-04-10 03:44:22
Previous
Bulk Business Owners Upload API (Early Access)
Next
Bulk Campaigns Upload API (Early Access)
Built with