Bulk Custom Insights (Entity Rules) Download API (Early Access)

BalkanID Custom Insights (Entity Rules)

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

Sample Entity Rule

ID	entity_filter	name	description	label	created_at	updated_at	created_by	updated_by
13323523	{"key1": "value1", "key2": ["value2", "value3"], "key3": {"nestedKey": "nestedValue"}}	Sample Insight	This is a sample description of the insight	Sample Label	2024-10-23T10:00:00Z	2024-10-23T11:00:00Z	user1	user2

Column Definitions

Column Name	Column Description
ID	Required - A unique identifier for the custom insight
entity_filter	Required - JSON filter used for computing the insight's entities
name	Required - Name of the insight
description	Optional - Description of the insight
label	Optional - A label for the insight's entities
created_at	Required - Timestamp when the insight was created
updated_at	Required - Timestamp when the insight was last updated
created_by	Optional - User who created the insight
updated_by	Optional - User who last updated the insight

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

BalkanID Custom Insights (Entity Rules)#

Sample Entity Rule#

Column Definitions#