Bulk Custom Insights (Entity Rules) Download API
POST
https://balkanid.app/api/rest/v0/entity-rules/download-url
BalkanID Custom Insights (Entity Rules)
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
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
Request Code Samples
Responses
Modified at 2026-11-06 13:38:07