CampaignService

by organizationId, clientKey

Retrieve a campaign.

get/v1/organizations/{organizationId}/campaigns/{clientKey}

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/v1/organizations/{organizationId}/campaigns/{clientKey}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required
clientKeystring required

Query parameters

campaignIdstring
skipReportSummariesboolean

If true, the response will omit the summary fields on the campaign's reports and set reports_include_summaries to false on the Campaign message. Reports will still be included with report_id and report_name populated. This significantly improves response times for campaigns with many reports. Defaults to false.

Response

A successful response.

Changes

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