campaigns

Get activities (v3)

Read what is next and what runs now for the organization's campaigns: id "organization", a product ("discovery", "experience", "research") or one campaign id. Returns the next customer and run; the customer work in flight (for a campaign, from its product's calendar: running, admitted and due, or placed and due, a launch whose first customer is ahead not in flight; for a product or the organization, from stored facts: every unfinished run Billing admitted for an entry as running, and each campaign's stored next customer once due); the part of it that campaigns a person paused or archived hold (finishing: earlier work finishing, none of it new); why nothing is scheduled when paused or on hold; Billing's admission of new work per product in scope; and the activity revision. A campaign Point11 holds (an operator stopped a run and has not released it) promises no next customer or run, and when nothing else in scope is active the pause names it (cause "hold").

get/api/v1/campaigns/activities-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/campaigns/activities-v3/{id}
  • 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)

Path parameters

'organization' | 'discovery' | 'research' | 'experience' required
OR
string uuid required

Headers

Point11-Organizationstring uuid

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

Response

Success.

observedAtstring required

ISO timestamp the activity was observed at.

throughstring required

ISO end of the window the plan reads through.

timeZonestring required

IANA zone the scope's work runs on.

state'ready' | 'paused' | 'no_campaigns' | 'unavailable' required
revisionstring nullable required

The organization's activity revision; null when it could not be read.

Changes

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