Bulk Entity Insights Download API (Early Access)

BalkanID Entity Insights Download CSV Format

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

Sample CSV

ID*	Insight*	Identity ID*	Identity Email*	Value*	Integration ID*
outlier/ghijkl	outlier	email/acbdef	user@email.com	`{ connections: [] , job: "engineer", department: "engineering", role: [], insight_type: "No Role", date identified: 1234, insight_description: "something here"}`	aws/123

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Required - ID of the Insight
Insight	Required - Name of the Insight, currently "outlier"
Identity ID	Required - ID of an Employee
Identity Email	Required - Email of an Employee
Value	Required - Is a JSON with the following format: `{ connections: [] , job: engineer, department: engineering, role: [], insight_type: One of Unique Connection(s)/Below Threshold/No Job Title/No Department, date identified: datetime, insight_description: something here}`
Integration ID	Required - The ID of the Integraion

Required Columns

All columns are required.

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 Entity Insights 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 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 Entity Insights Download API (Early Access)

BalkanID Entity Insights Download CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Download the CSV file via the pre-signed URL#