Function customerArchiveSearch

Create customer archive search Searches across all customer data with criteria based on a limited number of attributes on standard objects, including Message, Conversation, and Company objects, and on custom objects. Returns standard objects and custom objects older than 2 years ago that are unavailable in standard searches.

Any one of the following roles is required for this endpoint:

Filter on dates

You can filter by dates in either a local date YYYY-MM-DD format or a UTC date format. If you include a timezone in the query, a local date will be adjusted to account for the included timezone. UTC dates will not be timezone adjusted.

Example of search criteria with local date

{
"and": [
{
"conversation_created_at": {
"lte": "2020-11-19"
}
}
],
"queryContext": "conversation",
"timeZone": "America/New_York"
}
Copy

Note

The default GMT timezone is applied when you exclude a timezone.

Example of search criteria with UTC date

{
"and": [
{
"conversation_created_at": {
"lte": "2020-11-20T16:34:00.000Z"
}
}
],
"queryContext": "conversation"
}
Copy

Filtering

For a list of available standard attributes, see Standard attributes JSON schema.

Example of search criteria with standard attributes

[
{"conversation_updated_at": {"gte": "2016-06-24" }},
{"conversation_customer_id": {"equals": "65f49506237963001f01a391" }}
]
Copy

Sort on attributes

You can sort based on the following attributes:

conversation_created_at
conversation_updated_at
conversation_customer_id
conversation_deleted
customer_companyId
customer_created_at
customer_updated_at
customer_deleted
message_id
message_created_at
message_updated_at
kobject_created_at
kobject_updated_at
^kobject.*_created_at$
^kobject.*_updated_at$
company_created_at
company_updated_at
Copy

Example of sort with attributes

{"sort": [{"conversation_created_at": "asc"}]}
{"sort": [{"message_id": "asc"}, {"message_created_at": "asc"}]}
Copy

Note

Sorting based on other standard Object attributes is unavailable.

Pagination

There is a hard limit of 100 for the maximum number of pages.

There may be cases where you want to page through more records. For example, let's say you'd like to get an initial snapshot of data and then update the data.

To work around the pagination limit, you can write a query based on the updated_at attribute for a standard Object. You can then use the returned information in following API requests based on the last updated_at value from the response.

Filterable attributes JSON Schema

{
"type": "object",
"properties": {
"customer_any_text_new": {
"type": "string",
"operator": "any"
},
"customer_id": {
"type": "string",
"operator": "string_notanalyzed"
},
"customer_created_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"customer_updated_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"customer_companyId": {
"type": "string",
"operator": "string_notanalyzed"
},
"company_created_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"company_updated_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"message_any_text": {
"type": "string",
"operator": "any"
},
"message_created_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"message_updated_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"message_conversation_id": {
"type": "string",
"operator": "string_notanalyzed"
},
"conversation_any_text": {
"type": "string",
"operator": "any"
},
"conversation_created_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"conversation_updated_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"conversation_customer_id": {
"type": "string",
"operator": "string_notanalyzed"
},
"kobject_any_text": {
"type": "string",
"operator": "any"
},
"kobject_created_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
"kobject_updated_at": {
"type": "string",
"format": "date-time",
"operator": "datetime"
},
},
"additionalProperties": false
}

Copy