Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Import-Export

exportEntities

Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables. The values exported as in some cases, transformed to human-readable values.

To force the export of raw values, use the # prefix in front of your field name when specifying the field on the fields param.

post/v1/entity:export

Query parameters

job_idstring

The unique identifier of the import job.

Example:abc123

Export Job Id to get the result

is_templateboolean

Pass 'true' to generate import template

Pass 'true' to generate import template

languagestring

Export headers translation Language

Export headers translation language

Request body

qstring required

Lucene queries supported with ElasticSearch

include_scoresboolean

Adds a _score number field to results that can be used to rank by match score

frominteger

The offset from which to start the search results. Only one of from or search_after should be used.

sizeinteger

Max search size is 1000 with higher values defaulting to 1000

hydrateboolean

When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.

anonymizeboolean

When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms, addresses are generalized and well-known free-text fields are redacted. Anonymization is forced (regardless of this parameter) when the access token was created with anonymize: true.

fieldsstring[]

List of entity fields to include or exclude in the response

Use ! to exclude fields, e.g. !_id to exclude the _id field.

Globbing and globstart (**) is supported for nested fields.

aggsobject

Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.

include_deleted'true' | 'false' | 'only'

Whether to include deleted entities in the search results

  • true: include deleted entities
  • false: exclude deleted entities
  • only: include only deleted entities

By default, no deleted entities are included in the search results.

{"stackTrail":"components:schemas:EntitySearchParams:allOf:properties:highlight","oasType":"schema","type":"unknown"}
stable_forinteger

A TTL (in seconds) that specifies how long the context should be maintained. Defaults to 30 seconds; configurable up to 60 seconds to prevent abuse. A value of 0 can be provided the close the context after the query. Defaults to none.

stable_query_idstring

A unique identifier of the query context from the last stable query. The context is maintained for the duration of the stable_for value.

Example request

{
  "q": "_schema:contact AND status:active",
  "fields": [
    "_id",
    "_title",
    "first_name",
    "account",
    "!account.*._files",
    "**._product"
  ],
  "aggs": {
    "contact-count-per-tag": {
      "terms": {
        "field": "_tags.keyword"
      }
    }
  }
}

Response

created export url and download url