The Cloud Elements Query Language (CEQL) provides a standard way to search across all of our elements. Many API providers support some form of searching in their APIs but each one approaches searching differently. Rather than having you research how to query each resource at a provider, we've normalized your search experience. Cloud Elements translates your queries to the API provider's search syntax.
Use CEQL to query the following endpoints:
| Endpoint | Required CEQL |
|---|---|
| GET /activities | activityType = '<bounces, clicks, unsubscribes, or opens>' and campaignId = '<from GET /campaigns>' |
| POST /bulk/query | None |
| GET /campaigns | status ='<sent, scheduled, or draft>' and id = '<ClientID returned from GET/accounts>' |
| GET /lists | id = '<ClientID returned from GET/accounts>' |
| GET /lists/{listId}/contacts | status ='<active, unconfirmed, unsubscribed, bounced, or deleted>' and id = '<ClientID returned from GET/accounts>' |
| GET /{objectName} | None |
| GET /{objectName}/{objectId}/{childObjectName} | None |
| GET /segments | id = '<ClientID returned from GET/accounts>' |
For more information about CEQL, see the API documentation for the element or Querying with CEQL.
