Filters and Paginating Results

Pagination

All API methods that return a collection of records are paginated. Requests parameters and responses type always respect same format.

Request parameters

API methods that support pagination take two (optional) parameters:

JSON response

{
  "count": 4320,
  "offset": 90,
  "limit": 30,
  "records": [
    {},
    {}
  ]
}

Searching & Filtering

Most API methods that return a collection of records can be filtered if they accept a q parameters. Be informed that using search in API is much more resource intensive and may be subject to rate limiting.

Rules & Examples

There are certain search rules:

1. Basic format: {keyword}:{value}.
2. Multiple search parameter pairs are to be separated by spaces: {keyword1}:{value1} {keyword2}:{value2}.
3. If there's any space in {value}, double quote it: {keyword}:"a value with spaces".
4. If you want to apply filter for the same keyword for multiple times, simply separate them: {keyword}:{value1} {keyword}:{value2}.
5. text is provided as the default keyword, so no need to specify it explicitly: {keyword1}:{value1} text:{value} = {keyword1}:{value1} {value}.
6. Negate a keyword with -: -{keyword}:true = {keyword}:false.
7. Boolean values can be either true(1, on, yes) or false(0, off, no).

Try it with UI

Log in to RingCX Digital and go to Agent Inbox. Available search parameters are all in search field. After search, they will be in tab url after q=.

Try it with API calls

Endpoint: [GET] https://{account_name}.api.{platform_hostname}/1.0/content_threads

Auth: Bearer {accessToken} (refer to Authentication)

Query parameter: q={filters} (eg. q=assigned_to_me:"true")

Parameters

Additional Info

Date keywords

There are some keywords accepting date as value. The value can be given in a specific date format, or it can be a human readable string. When ambiguous, date interpretation will depend on the application locale, as follows:

In French: 03/04/2011 will be interpreted as the third day of the fourth month In English: 03/04/2011 will be interpreted as the fourth day of the third month But 03/17/2011 will be interpreted as the 17th day of the third month in both locales

Here are some examples of dates or strings that can be interpreted as dates:

• yesterday
• last month
• 2011-02-03
• 2011-02-03 14:27:33
• 2 hours ago
• 2 weeks ago at 4pm
• last friday at 20:00
• 4th day last week
• dec 25
• january 5 at 4

Business hours are the hours during the day in which business is commonly conducted. Typical business hours vary by domain.

Here are some examples of dates or strings that can be interpreted as business hours dates:

• 6 business hours ago
• 20 business minutes from now
• 1 business day ago

If a date without a time is given, the time will be considered as 00:00:00.

Sorting results

Returned results can be ordered by using order keyword. At the moment, ordering only supports created_at and last_content_at with asc or desc.

An example: q={keyword}:{value} order:created_at.asc (the default order is last_content_at.desc)