campaigns

Search calendars

Search the organization calendar by customer name, campaign name or a date phrase over the months around the grid being viewed. Returns the date the phrase names, matching campaigns, matching customers with their interaction counts, and those interactions in time order, at most 100, the ones nearest anchor; truncated says more customers or interactions matched than are returned, so more words narrow it; failed counts campaigns whose read failed. A query shorter than two characters reads only as a date. view "year" is a deprecated alias read as "month", so it searches a month's horizon.

get/api/v1/campaigns/calendars/search

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/campaigns/calendars/search
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Query parameters

view'day' | 'week' | 'month' | 'agenda' | 'year' required

"year" is a deprecated alias read as "month", so it searches a month's horizon.

anchorstring required
zonestring required
querystring required
wideboolean

Search six months each side of the grid, not one.

productsstring[]

Keep only these products' campaigns; none keeps every product.

profilesstring[]

Keep only these business profiles' campaigns; none keeps every profile.

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

truncatedboolean required

More customers or interactions matched than are returned: more words narrow it.

failedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.