Learn
Content
Tracks
Tracks
Build your expertise through a collection of training modules
Curriculums
Curriculums
Follow recommended learning paths based on specific products or roles
Resources
Help
Help
Visit our Help Site for articles and answers to product questions.
Blog
Blog
Gain insight into product functionality, and best practices.
Releases
Releases
Check out the latest seasonal product updates, and monthly Hitchhiker-exclusives.
Frontend Code Examples
Admin Code Snippets
Explore code snippets to customize your Answers and Pages build.
Guides
Get Started Guides Integration Guides Developer Guides View All
Start Building For Free
Docs
API Docs
Knowledge API Live API Admin API Answers API
SDK & CLI Docs
Answers Search UI SDK Answers Core SDK Yext CLI CaC Resources
Guides
Get Started Guides Integration Guides Developer Guides View All
Start Building For Free
Community
Resources
Community
Hitchhikers Community
Ask questions, share best practices, and engage with fellow Hitchhikers.
Store
Hitchhikers Store
Shop for Hitchhikers apparel, drinkware, and accessories.
Events
Events
Explore the calendar of upcoming office hours, workshops, and webinars.
Customer Showcase
Customer Showcase
Learn how brands are winning big in search.
Start Building For Free
Start Building For Free
<% ((user.first_name && user.first_name.split(' ').join('').length > 0) || (user.last_name && user.last_name.split(' ').join('').length > 0)) ? (user.first_name + ' ' + user.last_name) : 'Hitchhiker' %>
<% util.level ? util.level.title : '' %>
explorer pioneer apollo viking voyager pathfinder orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Program Track Completed Knowledge Graph Track Completed Pages Track Completed Answers Track Completed Answers: Advanced Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Knowledge Assistant Track Completed Multi-Language Experiences Track
<% util.expandBadges ? 'Less' : 'More' %>
Profile
<% user.first_name && user.last_name ? user.first_name + ' ' + user.last_name : user.full_name %>
<% user.email %>
Control Center
Settings Log Out loading
Ready to be your brand's hero?
Sign up to become a Hitchhiker and build skills that will enhance your career, get access to exclusive Yext resources, and be your brand’s hero by driving consumer engagement.

If you’re already a Hitchhiker, log in to access this content.
Log In Sign Up
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
Search
API Policies & Conventions
Knowledge APIs
Expand Expand
Knowledge Graph
Expand Expand
Entities
Expand Expand
Entities
Expand Expand
Entities: List
Entities: Create
Entities: Get
Entities: Update
Entities: Delete
Entity Language Profiles
Expand Expand
Entity Language Profiles: List
Entity Language Profiles: List All
Entity Language Profiles: Get
Entity Language Profiles: Upsert
Entity Language Profiles: Delete
Locations (Legacy)
Expand Expand
Locations (Legacy): List
Locations (Legacy): Create
Locations (Legacy): Search
Locations (Legacy): Get
Locations (Legacy): Update
Language Profiles (Legacy)
Expand Expand
Language Profiles (Legacy): List
Language Profiles (Legacy): Get
Language Profiles (Legacy): Upsert
Language Profiles (Legacy): Delete
Folders
Expand Expand
Folders: List
ECLs
Expand Expand
Menus
Expand Expand
Menus: List
Menus: Create
Menus: Get
Menus: Update
Menus: Delete
Bios
Expand Expand
Bios: List
Bios: Create
Bios: Get
Bios: Update
Bios: Delete
Products
Expand Expand
Products: List
Products: Create
Products: Get
Products: Update
Products: Delete
Events (Legacy)
Expand Expand
Events (Legacy): List
Events (Legacy): Create
Events (Legacy): Get
Events (Legacy): Update
Events (Legacy): Delete
Categories & Google Attributes
Expand Expand
Categories
Google Fields
Custom Fields
Expand Expand
Custom Fields: List
Custom Fields: Create
Custom Fields: Get
Custom Fields: Update
Custom Fields: Delete
Assets
Expand Expand
Assets: List
Assets: Create
Assets: Get
Assets: Update
Assets: Delete
Connectors
Expand Expand
Connectors: Push Data
Connectors: Trigger
Listings
Expand Expand
Listings Management
Expand Expand
Listings
Expand Expand
Listings: List
Listings: Opt In
Listings: Opt Out
Entity Listings
Expand Expand
Entity Listings: List
Entity Listings: Delete
Duplicates
Expand Expand
Duplicates: List
Duplicates: Create
Duplicates: Delete
Duplicates: Suppress
Publishers
Publisher Suggestions
Expand Expand
Publisher Suggestions: List
Publisher Suggestions: Get
Publisher Suggestions: Update
Google Verification
Expand Expand
Verification Methods
Verification Statuses
Verification
Expand Expand
Verification: Initiate
Verification: Complete
Listing Admins
Expand Expand
Listing Admins: List
Listing Admin: Invite
Q&A
Expand Expand
Questions
Expand Expand
Questions: List
Question: Get
Answer
Expand Expand
Answer: Create
Answer: Update
Answer: Delete
Analytics
Expand Expand
Activity Log
Catalog
Max Dates
Reports
Report Status
Reviews
Expand Expand
Review Management
Expand Expand
Reviews
Expand Expand
Reviews: List
Reviews: Create
Review: Get
Review: Update
Comment
Expand Expand
Comment: Create
Comment: Update
Comment: Delete
Review Labels
Review Generation
Expand Expand
Review Invitations
Expand Expand
Review Invitations: List
Review Invitations: Create
Review Invitation: Get
Review Invitation: Update
Review Invitation: Delete
Review Generation Settings
Expand Expand
Review Generation Settings: Get
Review Generation Settings: Update
Account Settings
Expand Expand
Users
Expand Expand
Roles
Users
Expand Expand
Users: List
Users: Create
Users: Get
Users: Update
Users: Delete
Users: Update Password
Approval Groups
Expand Expand
ApprovalGroups: List
Approval Groups: Create
ApprovalGroups: Get
ApprovalGroups: Update
ApprovalGroups: Delete
Accounts
Expand Expand
Accounts: List
Accounts: Get
Linked Accounts
Expand Expand
LinkedAccounts: List
LinkedAccounts: Get
LinkedAccounts: Assign
Optimization Tasks
Expand Expand
Optimization Tasks: List
Optimization Tasks: Get Link
Webhooks
Expand Expand
Knowledge Graph
Expand Expand
Entities
Locations
ECLs
Expand Expand
Menus: Webhook
Bios: Webhook
Products: Webhook
Events: Webhook
Listings
Expand Expand
Listings
Entity Listings
Duplicates
Publisher Suggestions
Q&A
Reviews
Expand Expand
Reviews
Review Invitations
Unlink Account
Expand Expand
Account Unlink: Webhook
Add Request
Expand Expand
Add Request Update: Webhook
Live APIs (Consumer Grade)
Expand Expand
Knowledge Graph Live API
Expand Expand
Entities
Expand Expand
Entities
Expand Expand
Entities: List
Entities: Get
Entities: GeoSearch
Entities Schema: Get
Entity Language Profiles
Expand Expand
Entity Language Profiles: Get
Entity Language Profiles: List
Entity Language Profiles: List All
Locations (Legacy)
Expand Expand
Language Profiles (Legacy): Get
Language Profiles Schema (Legacy): Get
Locations (Legacy): Get
Locations (Legacy): List
Locations Schema (Legacy): Get
Locations (Legacy): GeoSearch
ECLs
Expand Expand
Menus
Bios
Products
Events (Legacy)
Q&A Submission
Expand Expand
Q&A Submission
Review Submission
Expand Expand
Review Submission
Expand Expand
Review: Create
Review: Update
Review: Delete
Streams
Expand Expand
Streams
Expand Expand
Streams: Get
Streams: List
Answers API
Expand Expand
Universal Search
Expand Expand
Universal Search: Autocomplete
Universal Search: Query
Vertical Search
Expand Expand
Vertical Search: Autocomplete
Vertical Search: Query
Vertical Search: Filter Search
Secure Token
Expand Expand
Secure Token
Admin APIs (Partner)
Expand Expand
Available Services
Expand Expand
Available Services: List
Add Requests
Expand Expand
Add Requests: Create (New Location)
Add Requests: Create (Existing Location)
Add Requests: Create (Existing Sub-Account)
Add Requests: Process (Sandbox API Only)
Add Requests: List (Location)
Add Requests: Get (Location)
Add Requests: List (Sub-Account)
Add Requests: Get (Sub-Account)
Services
Expand Expand
Services: Cancel (Location)
Services: Cancel (Sub-Account)
Services: Cancel All (Sub-Account)
Services: List (Location)
Services: List (Sub-Account)
Accounts
Expand Expand
Accounts: Create Sub-Account
Accounts: List
Accounts: Get
Accounts: Update
Answers Search UI SDK
Expand Expand
Core Concepts
Expand Expand
Answers Initialization
Components
Universal vs. Vertical Search
Result Cards
Expand Expand
Built-In Card Configuration
Card Data Mapping
Card Calls To Action
Data Formatting
Built In Cards
Pages
Expand Expand
Universal Search Results Page
Vertical Search Results Page
No Results
Components
Expand Expand
SearchBar
Navigation
SpellCheck
DirectAnswer
UniversalResults
VerticalResults
FilterSearch
FilterOptions
FilterBox
Facets
SortOptions
QASubmission
Map
Pagination
LocationBias
Icon
Initialization Options
Expand Expand
verticalPages
search
onUniversalSearch
onVerticalSearch
Advanced Concepts
Expand Expand
Component Lifecycle and State
Using a Custom Renderer
Custom Data Transforms
Using a Custom Template for a Component
Custom Data Formatting
Creating Custom Components
More Information
Expand Expand
Versions
Bundles
Yext CLI (Beta)
Expand Expand
Installation
Getting Started
Expand Expand
Link Your Account
Exploring Commands & Using the Help Flag
Universal Commands
Expand Expand
init
info
completion
Resources Command Group
Expand Expand
apply
diff
pull
Service Users Command Group
Expand Expand
activate
create
list
remove
Streams CLI Command Group
Expand Expand
list
refresh list
refresh status
view records
Configuration Resources
Expand Expand
Analytics
Expand Expand
Conversion Action
Dashboard
Insight
Answers
Expand Expand
Answers Configuration
Experience Training
Saved Query
Crawler
Expand Expand
Yext Crawler
Knowledge Manager
Expand Expand
Connector
Entity
Entity Folder
Entity Label
Entity Preview
Entity Template
Entity Type
Entity Type Extension
Entity Upload Configuration
Field
Field Presentation
Field Type
Knowledge Graph Settings
Saved Filter
Pages
Expand Expand
Authentication Policy
Domain
Module
Page Builder Template
Site
Platform
Expand Expand
Account Features
Home Screen
Role
Streams
Expand Expand
Streams Endpoint
home
loading
Documentation Powered by ReDoc

Entity Language Profiles: Get

Retrieve a Language Profile for an Entity

NOTE:

  • Responses will contain resolved values for embedded fields
  • If the fields parameter is unspecified, responses will contain the full entity profile for the requested language
path Parameters
accountId
required
string >= 0 characters
entityId
required
string >= 0 characters

The external ID of the requested Entity

languageCode
required
string >= 0 characters

The language code corresponding to the language of the profiles that the user wishes to retrieve

query Parameters
v
required
string >= 0 characters

A date in YYYYMMDD format.

fields
string >= 0 characters

Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., "address.line1"). Custom fields are specified in the same way, albeit with their c_* name.

format
string >= 0 characters
Default: "markdown"

Present if and only if at least one field is of type "Rich Text."

Valid values:

  • markdown
  • html
  • none

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Entity Language Profiles: List

Retrieve Language Profiles for an Entity

NOTE:

  • Responses will contain resolved values for embedded fields
  • If the fields parameter is unspecified, responses will contain the full entity profile for the requested language
path Parameters
accountId
required
string >= 0 characters
entityId
required
string >= 0 characters

The external ID of the requested Entity

query Parameters
v
required
string >= 0 characters

A date in YYYYMMDD format.

entityTypes
string >= 0 characters

Comma-separated list of Entity types to filter on. Example: "location,event"

Should be from the following types:

  • atm
  • event
  • faq
  • financialProfessional
  • healthcareFacility
  • healthcareProfessional
  • hotel
  • hotelRoomType
  • job
  • location
  • organization
  • product
  • restaurant

OR the API name of a custom entity type.

fields
string >= 0 characters

Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., "address.line1"). Custom fields are specified in the same way, albeit with their c_* name.

format
string >= 0 characters
Default: "markdown"

Present if and only if at least one field is of type "Rich Text."

Valid values:

  • markdown
  • html
  • none
languageCodes
string >= 0 characters

The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Entity Language Profiles: List All

Retrieve a list of Language Profiles for Entities within an account

NOTE:

  • Responses will contain resolved values for embedded fields
  • If the fields parameter is unspecified, responses will contain the full entity profile for the requested language
path Parameters
accountId
required
string >= 0 characters
query Parameters
v
required
string >= 0 characters

A date in YYYYMMDD format.

entityTypes
string >= 0 characters

Comma-separated list of Entity types to filter on. Example: "location,event"

Should be from the following types:

  • atm
  • event
  • faq
  • financialProfessional
  • healthcareFacility
  • healthcareProfessional
  • hotel
  • hotelRoomType
  • job
  • location
  • organization
  • product
  • restaurant

OR the API name of a custom entity type.

fields
string >= 0 characters

Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., "address.line1"). Custom fields are specified in the same way, albeit with their c_* name.

filter
string >= 0 characters

This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object.

For example, if the filter JSON is {"name":{"$eq":"John"}}, then the filter param after URL-encoding will be: filter=%7B%22name%22%3A%7B%22%24eq%22%3A%22John%22%7D%7D

Basic Filter Structure

The filter object at its core consists of a matcher, a field, and an argument.

For example, in the following filter JSON:

{
  "name":{
    "$eq":"John"
  }
}

$eq is the matcher, or filtering operation (equals, in this example),

name is the field being filtered by, and

John is value to be matched against.

Combining Multiple Filters

Multiple filters can be combined into one object using combinators. For example, the following filter JSON combines multiple filters using the combinator $and. $or is also supported.

{
  "$and":[
    {
      "firstName":{
        "$eq":"John"
      }
    },
    {
      "countryCode":{
        "$in":[
          "US",
          "GB"
        ]
      }
    }
  ]
}

Filter Negation

Certain filter types may be negated. For example:

{
  "$not" {
    "name":{
      "$eq":"John"
    }
  }
}

This can also be written more simply with a ! in the $eq parameter. The following filter would have the same effect:

{
  "name":{
    "!$eq":"John"
  }
}

Filter Complement

You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something.

{
  "$complement":{
    "description":{
      "$contains":"hello"
    }
  }
}

Addressing Subfields

Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called c_myCustomField:

{
  "c_myCustomField":{
    "age": 30,
    "name": "Jim",
  }
}

While filtering, subfields may be addressed using the "dot" notation.

{
  "c_myCustomField.name":{
    "!$eq":"John"
  }
}

Fields that are nested deeper may be addressed using dot notation, as well. For example, if name in the above example was a compound field with two subfields first and last, first may be addressed as c_myCustomField.name.first.

Field Support

Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field name supports the TEXT filter type, which supports $eq (equals) and $startsWith (starts with).

TEXT

The TEXT filter type is supported for text fields. (e.g., name, countryCode)

Matcher Details
$eq (equals) 
{
  "countryCode":{
    "$eq":"US"
  }
},
{
  "countryCode":{
    "!$eq":"US"
  }
}

Supports negation. Case insensitive.

$startsWith

Matches if the field starts with the argument value.

e.g., "Amazing" starts with "amaz"

{
   "address.line1":{
      "$startsWith": "Jo"
   }
}

Supports negation. Case insensitive.

$in

Matches if field value is a member of the argument list.

{
  "firstName":{
    "$in": ["John", "Jimmy"]
  }
}

Does not support negation. Negation can be mimicked by using an "OR" matcher, for example:

{
  "$and":[
    {
      "firstName":{
        "!$eq": "John"
      }
    },
    {
      "firstName":{
        "!$eq": "Jimmy"
      }
    }
  ]
}
$contains 
{
  "c_myString":{
    "$contains":"sample"
  }
}

This filter will match if "sample" is contained in any string within c_myString.

Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces".

Supports negation.

$containsAny 
{
  "c_myString":{
    "$containsAny":[
      "sample1", "sample2"
    ]
  }
}

This filter will match if either "sample1" or "sample2" is contained in any string within c_myString. The argument list can contain more than two strings.

Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces".

Supports negation.

$containsAll 
{
  "c_myString":{
    "$containsAll":[
      "sample1",
      "sample2"
    ]
  }
}

This filter will match if both "sample1" and "sample2" are contained in any string within c_myString. The argument list can contain more than two strings.

Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces".

Supports negation.

BOOLEAN

The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.

Matcher Details
$eq 
{
  "isFreeEvent": {
    "$eq": true
  }
}

For booleans, the filter takes a boolean value, not a string. Supports negation.

STRUCT

The STRUCT filter type is supported for compound fields with subfields.

e.g., address, featuredMessage, fields of custom types

Matcher Details
$hasProperty

Matches if argument is a key (subfield) of field being filtered by. This filter type is useful for filtering by compound fields or to check if certain fields have a value set.

{
  "address": {
    "$hasProperty": "line1"
  }
}

Note that if a given property of a compound field is not set, the filter will not match. For example, if line1 of address is not set for an entity, then the above matcher will not match the entity.

Supports negation.

OPTION

The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values.

e.g., eventStatus, gender, SINGLE_OPTION and MULTI_OPTION types of custom fields.

Matcher Details
$eq

Matching is case insensitive and insensitive to consecutive whitespace.

e.g., "XYZ 123" matches "xyz 123"

{
  "eventStatus": {
    "$eq": "SCHEDULED"
  }
}

Supports negation. Negating $eq on the list will match any field that does not hold any of the provided values.

$in 
{
  "eventStatus": {
    "$in": [
      "SCHEDULED",
      "POSTPONED"
    ]
  }
}

Does not support negation. However, negation can be mimicked by using an $and matcher to negate individually over the desired values. For example:

{
  "$and": [
    {
      "eventStatus":{
        "!$eq": "SCHEDULED"
      }
    },
    {
      "firstName":{
        "!$eq": "POSTPONED"
      }
    }
  ]
}

PHONE

The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for $eq, the same phone number with or without calling code will match.

Matcher Details
$eq 
{
  "mainPhone":{
    "$eq":"+18187076189"
  }
},
{
  "mainPhone":{
    "$eq":"8187076189"
  }
},
{
  "mainPhone":{
    "!$eq":"9177076189"
  }
}

Supports negation. Case insensitive.

$startsWith

Matches if the field starts with the argument value.

e.g., "8187076189" starts with "818"

{
  "mainPhone":{
    "$startsWith": "818"
  }
}

Supports negation. Case insensitive.

$in

Matches if field value is a member of the argument list.

{
  "mainPhone":{
    "$in": [
      "8185551616",
      "9171112211"
    ]
  }
}

Does not support negation. However, negation can be mimicked by using an $and matcher to negate individually over the desired values.

INTEGER, FLOAT, DATE, DATETIME, and TIME

These filter types are strictly ordered -- therefore, they support the following matchers:

  • Equals
  • Less Than / Less Than or Equal To
  • Greater Than / Greater Than or Equal To
Matcher Details
$eq

Equals

{
  "ageRange.maxValue": {
    "$eq": "80"
  }
}

Supports negation.

$lt

Less than

{
  "time.start": {
    "$lt": "2018-08-28T05:56"
  }
}
$gt

Greater than

{
  "ageRange.maxValue": {
    "$gt": "50"
  }
}
$le

Less than or equal to

{
  "ageRange.maxValue": {
    "$le": "40"
  }
}
$ge

Greater than or equal to

{
  "time.end": {
    "$ge":  "2018-08-28T05:56"
  }
}
Combinations

While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation:

{
  "ageRange.maxValue : {
    "$gt" : 10,
    "$lt": 20
  }
}

LIST OF TEXT

Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the $contains matcher.

Matcher Details
$eq 
{
  "c_myStringList": {
    "$eq": "sample"
  }
}

This filter will match if "sample" EXACTLY matches any string within c_myStringList.

Supports negation.

$eqAny 
{
  "c_myStringList": {
    "$eqAny": [
      "sample1",
      "sample2"
    ]
  }
}

This filter will match if any one of "sample1" or "sample2" EXACTLY match a string within c_myStringList . The argument can have more than two strings.

Supports negation.

$eqAll 
{
  "c_myStringList": {
    "$eqAll": [
      "sample1",
      "sample2"
    ]
  }
}

This filter will match if both "sample1" AND "sample2" EXACTLY match a string within c_myStringList. The argument can have more than two strings.

Supports negation.

$contains 
{
  "c_myStringList":{
    "$contains":"sample"
  }
}

This filter will match if "sample" is contained in any string within c_myStringList.

Note that this matching is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces".

Supports negation.

$containsAny 
{
  "c_myStringList": {
    "$containsAny": [
      "sample1",
      "sample2"
    ]
  }
}

This filter will match if either "sample1" or "sample2" is contained in any string within c_myStringList. The argument list can have more than two strings.

Note that similar to $contains, the matching for $containsAny is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces".

Supports negation.

$containsAll 
{
  "c_myStringList": {
    "$containsAll": [
      "sample1",
      "sample2"
    ]
  }
}

This filter will match if BOTH "sample1" and "sample2" are contained in strings within c_myStringList. The argument list can have more than two strings.

Note that similar to $contains, the matching for $containsAll is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces".

Supports negation.

$startsWith 
{
  "c_myStringList": {
    "$startsWith":"sample"
  }
}

This filter will match if any string within c_myStringList starts with "sample".

Does not supports negation. Case Insensitive.

LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME

Matcher Details
$eq 
{
  "c_myDateList": {
    "$eq": "2019-01-01"
  }
}

This filter will match if "2019-01-01" EXACTLY matches any date within c_myDateList.

Supports negation.

$eqAny 
{
  "c_myIntegerList": {
    "$eqAny": [1, 2]
  }
}

This filter will match if 1 or 2 EXACTLY match any integer within c_myIntegerList. The argument list can have more than two elements.

Supports negation.

$eqAll 
{
  "c_myStringList": {
    "$eqAll": [
      "sample1",
      "sample2"
    ]
  }
}

This filter will match if both "2019-01-01" AND "2019-01-02" EXACTLY match a date within c_myDateList. The argument list can have more than two elements.

Supports negation.

LIST OF STRUCT

Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type. For example, if c_myStructList is a list of compound fields with the subfields age and name, then one can address the age properties of each field in c_myStructList as a flattened list of integers and filtering upon them. For example, the following filter:

{
  "c_myStructList.age":{
    "$eq": 20
  }
}

will match if any field in the list has an age property equal to 20. Similarly, any filter that can be applied to lists of integers could be applied to age in this case ($eq, $eqAll, $eqAny).

HOURS

By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.

Matcher Details
$openAt 
{
  "hours": {
    "$openAt":
      "2019-01-06T13:45"
  }
}

This filter would match entities open at the specified time.

$closedAt 
{
  "hours": {
    "$closedAt:
      "2019-01-06T13:45"
  }
}
$openForAllOf 
{
  "hours": {
    "$openForAllOf": {
      "start":
        "2019-01-06T13:45",
      "end":
        "2019-01-06T15:00"
    }
  }
}

This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00.

{
  "hours": {
    "$openForAllOf":
      "2019-05-10"
  }
}

This filter would match entities open for the entire 24 hour period on 2019-05-10.

You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.

$openForAnyOf 
{
  "hours": {
    "$openForAnyOf": {
      "start": "now",
      "end": "now+2h"
    }
  }
}

This filter will match any entities that are open for at least a portion of the time range between now and two hours from now.

$closedForAllOf 
{
  "hours": {
    "$closedForAllOf": {
      "start":
        "2019-01-06T13:45",
      "end":
        "2019-01-06T15:00"
    }
  }
}

This filter will match only those entities that are closed for the entire given time range.

$closedForAnyOf 
{
  "hours": {
    "$closedForAnyOf": {
      "start":
        "2019-01-06T13:45",
      "end":
        "2019-01-06T15:00"
    }
  }
}

This filter will match any entities that are closed for at least a portion of the given time range.

Filtering by Dates and Times

Time zones

The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities.

To search in local time, simply provide the date or time without any zone: 2019-06-07T15:30 or 2019-06-07.

To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: 2019-06-07T15:30[America/New_York] or 2019-06-06[America/Phoenix].

Date and time types

In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter:

{
  "time.start": {
    "$eq": "2018"
  }
}

would match all start times in the year 2018. The same logic would apply for a month (2019-05), a date (2019-05-01), or an hour (2019-05-01T06).

These types also work with ordered searches. For example:

{
 "time.start": {
    "$lt": "2018"
 }
}

would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a $le matcher would include anything in or before 2018.

"Now" and Date Math

Instead of providing a static date or time, you can also use now in place of any date time. When you do so, the system will calculate the time when the query is made and conduct a zoned search.

In order to search for a future or past time relative to now, you can use date math. For example, you can enter now+3h or now-1d, which would mean 3 hours from now and 1 day ago, respectively. You can also add and subtract minutes (m), months (M), and years (y).

It is also possible to add or subtract time from a static date or datetime. Simply add || between the static value and any addition or subtraction. For example, 2019-02-03||+1d would be the same as 2019-02-04.

You can also convert date and time types to other types. For example, to convert the datetime 2019-05-06T22:15 to a date, use 2019-05-06T22:15||/d. Doing so would yield the same result as using 2019-05-06. This method also works with now: now/d will give you today’s date without the time.

Filtering Across an Entity

It is possible to search for a specific text string across all fields of an entity by using the $anywhere matcher.

Matcher Details
$anywhere

Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists)

{
  "$anywhere": "hello"
}

This filter will match all entities that contain the string "hello" or strings that begin with "hello".

Examples

The following filter will match against entities that:

  • Are of type event (note that entity types can also be filtered by the entityTypes query parameter)
  • Have a name that starts with the text "Century"
  • Have a maximum age between 10 and 20
  • Have a minimum age between 5 and 7
  • Start after 7 PM (19:00) on August 28, 2018
{
  "$and":[
    {
      "entityType":{
        "$eq":"event"
      }
    },
    {
      "name":{
        "$startsWith":"Century"
      }
    },
    {
      "ageRange.maxValue":{
        "$gt":10,
        "$lt":20
      }
    },
    {
      "ageRange.minValue":{
        "$gt":5,
        "$lt":7
      }
    },
    {
      "time.start":{
        "$ge":"2018-08-28T19:00"
      }
    }
  ]
}
format
string >= 0 characters
Default: "markdown"

Present if and only if at least one field is of type "Rich Text."

Valid values:

  • markdown
  • html
  • none
languageCodes
string >= 0 characters

The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve

limit
number multiple of 1 <= 50
Default: "10"

Number of results to return.

offset
number multiple of 1
Default: "0"

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given.

pageToken
string >= 0 characters

If a response to a previous request contained the pageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data.

sortBy
string >= 0 characters

A list of fields and sort directions to order results by. Each ordering in the list should be in the format {"field_name", "sort_direction"}, where sort_direction is either ASCENDING or DESCENDING.

For example, to order by name the sort order would be [{"name":"ASCENDING"}]. To order by name and then description, the sort order would be [{"name":"ASCENDING"},{"description":"ASCENDING"}].

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {