Profile API key

The identity provider.

Third-party authentication token used to authenticate with the Identity Provider. Required if identityProvider is different than SYNERISE.

Profile email. Required if identityProvider is SYNERISE and email is the unique identifier (default setting).

Profile customId. Required if identityProvider is SYNERISE and customId is the unique identifier (see https://help.synerise.com/docs/settings/configuration/non-unique-emails/).

Profile password. Required if identityProvider is SYNERISE.

Profile UUID. Required if identityProvider is SYNERISE.

Unique Android or iOS device ID

This object contains the marketing agreements of the Profile.

You can also pass the values as strings ("true";"True"/"false";"False") or integers (1 for true and 0 for false).

This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration.

If you want to send a date/time attribute for use in analytics, take the following into account:

• The date/time should be formatted according to ISO 8601.
• The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example:
  • 2023-10-09T12:00:00 doesn't have a timezone indicator and will be considered as a time in the workspace's time zone.
  • 2023-10-09T12:00:00+02:00 has a timezone indicator (+02:00), so the timezone of the workspace doesn't affect it.
  • 2023-10-09T12:00:00Z is a time in the UTC time zone (denoted by the Z at the end), so the timezone of the workspace doesn't affect it.

WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored.

Profile API key

The identity provider.

Third-party authentication token used to authenticate with the Identity Provider. Required if identityProvider is different than SYNERISE.

Profile email. Required if identityProvider is SYNERISE and email is the unique identifier (default setting).

Profile customId. Required if identityProvider is SYNERISE and customId is the unique identifier (see https://help.synerise.com/docs/settings/configuration/non-unique-emails/).

Profile password. Required if identityProvider is SYNERISE.

Profile UUID. Required if identityProvider is SYNERISE.

Unique Android or iOS device ID

This object contains the marketing agreements of the Profile.

You can also pass the values as strings ("true";"True"/"false";"False") or integers (1 for true and 0 for false).

This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration.

If you want to send a date/time attribute for use in analytics, take the following into account:

• The date/time should be formatted according to ISO 8601.
• The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example:
  • 2023-10-09T12:00:00 doesn't have a timezone indicator and will be considered as a time in the workspace's time zone.
  • 2023-10-09T12:00:00+02:00 has a timezone indicator (+02:00), so the timezone of the workspace doesn't affect it.
  • 2023-10-09T12:00:00Z is a time in the UTC time zone (denoted by the Z at the end), so the timezone of the workspace doesn't affect it.

WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored.

Profile API key (same as for Profile login)

Unique Android or iOS device ID

The login (email address) of the user

The user's password

Identifier of user's current device

Multi-factor verification code

Query text to use in the search

Page number to return for pagination. The first page has the index 1.

The number of items to return per page

Name of the attribute by which the data will be sorted.

Sorting by attribute may cause a promoted item to be in a different position that defined in a query rule.

Sorting order

When true, pagination metadata is included in the response body.

When false, the data is included in the response headers:

• Link: links to neighbors, first, and last pages in pagination.

• X-Pagination-Total-Count: total number of items on all pages

• X-Pagination-Total-Pages: total number of pages

• X-Pagination-Page: current page

• X-Pagination-Limit: maximum number of items on a page

• X-Pagination-Sorted-By: parameter that the items were sorted by

• X-Pagination-Ordering: sorting direction

UUID of the profile for which the search is performed

If set to false, the search result is not personalized.

correlationId of the request which this event relates to, for example a recommendation or search request (the parameter is included in the response to that request).

DEPRECATED - use correlationId instead

Search ID for pagination. If a search with the ID was performed recently (last 10 minutes), the cached results will be used.

Do not send this if sortBy/filters/sorting order, etc. have changed - the cached results may have different order or may match different filters.

Name of the metric by which the data will be sorted

Geo-point ({latitude},{longitude}) for data sorting. Results are sorted by distance from this point. ordering: asc means "closest first".

The definition of a geographical area to filter by.

Given one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the filterAroundRadius parameter. Example input: ["34.052235,-118.243685"]

Given two geo-points, the results will be limited to a rectangular area. The first point defines the upper-left corner of the rectangle and the second is the lower-right corner. Example input: ["50,-100", "25,150"]

Given three or more geo-points, the results will be limited to a polygonal area. Example input: ["50,0", "40,20", "-20,10"]

Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point.

IQL query string. For details, see the Help Center.

A list of attributes for which facets will be returned. A single * value matches all facetable attributes.

To determine which groups of facets should be returned, use the includeFacets parameter.

A key-value map that takes attributes as keys and IQL query strings as values.

For each key a facet is returned that includes only the items filtered by the provided IQL query string.

Determines how many items will be used for facets aggregation.

Determines how many values will be retrieved per facet.

Specifies whether facets aggregation should be case sensitive.

Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.

To determine which attributes should be returned as facets in each group, use the facets parameter.

List of context strings for a search query

List of ad hoc attributes that will be returned for each found item

Query text to use in the search

Page number to return for pagination. The first page has the index 1.

The number of items to return per page

Name of the attribute by which the data will be sorted.

Sorting by attribute may cause a promoted item to be in a different position that defined in a query rule.

Sorting order

When true, pagination metadata is included in the response body.

When false, the data is included in the response headers:

• Link: links to neighbors, first, and last pages in pagination.

• X-Pagination-Total-Count: total number of items on all pages

• X-Pagination-Total-Pages: total number of pages

• X-Pagination-Page: current page

• X-Pagination-Limit: maximum number of items on a page

• X-Pagination-Sorted-By: parameter that the items were sorted by

• X-Pagination-Ordering: sorting direction

UUID of the profile for which the search is performed

Name of the metric by which the data will be sorted

Geo-point ({latitude},{longitude}) for data sorting. Results are sorted by distance from this point. ordering: asc means "closest first".

The definition of a geographical area to filter by.

Given one geo-point, the results will be limited to a radius around a point. To override the default radius (1000 meters), provide the filterAroundRadius parameter. Example input: ["34.052235,-118.243685"]

Given two geo-points, the results will be limited to a rectangular area. The first point defines the upper-left corner of the rectangle and the second is the lower-right corner. Example input: ["50,-100", "25,150"]

Given three or more geo-points, the results will be limited to a polygonal area. Example input: ["50,0", "40,20", "-20,10"]

Radius in meters to be used when filtering using geo-location. Can only be used when filtering by a single geo-point.

IQL query string. For details, see the Help Center.

A list of attributes for which facets will be returned. A single * value matches all facetable attributes.

To determine which groups of facets should be returned, use the includeFacets parameter.

A key-value map that takes attributes as keys and IQL query strings as values.

For each key a facet is returned that includes only the items filtered by the provided IQL query string.

Determines how many items will be used for facets aggregation.

Determines how many values will be retrieved per facet.

Specifies whether facets aggregation should be case sensitive.

Determines which groups of facets will be returned: both filtered and unfiltered; just filtered; just unfiltered; or no group at at all.

To determine which attributes should be returned as facets in each group, use the facets parameter.

List of context strings for a search query

List of ad hoc attributes that will be returned for each found item

Deleted search query. Required if match field is set to query.

Tells how to match this deleted search on recent searches.

• query: matches only recent searches with provided query
• all: matches all recent searches