Campaign Tools

Use the campaign tools to search campaigns and retrieve campaign support context in the workspace bound to your API key.

Available tools

Tool
Purpose

campaign_find

Search campaigns by query and optional status.

campaign_get_summary

Return the main operational summary for one campaign.

campaign_get_support_context

Return support-specific context for one campaign.

campaign_find

Search campaigns by free text.

Parameters

Name
Type
Required
Description

query

String

Yes

Search query. Maximum length: 120.

status

String

No

One of active, paused, deleted, planned, running.

limit

Integer

No

Result limit. Default: 10. Maximum: 10.

Response

{
  "items": [
    {
      "publicId": "cp_01hj5kq4k4a2v3x7p9m8n6c2dz",
      "name": "Spring Launch",
      "status": "running",
      "startDate": "2026-03-01",
      "endDate": "2026-04-15"
    }
  ]
}

Notes

  • When no status filter is provided, deleted campaigns are excluded.

  • The returned status can be deleted, paused, planned, running, or completed.

campaign_get_summary

Return the main operational summary for one campaign.

Parameters

Name
Type
Required
Description

campaignPublicId

String

Yes

Campaign public ID in cp_<lowercase_ulid> format.

Response

campaign_get_support_context

Return support-focused targeting and anomaly information for one campaign.

Parameters

Name
Type
Required
Description

campaignPublicId

String

Yes

Campaign public ID in cp_<lowercase_ulid> format.

Response

Field notes

  • anomalies returns a compact summary of active anomalies with type and state.

  • targeting is designed for support and operational triage, not for full targeting export.

Last updated