GetCampaign

Retrieve a campaign.

GET /api/v1/campaigns/{campaignId}

GetCampaign

cURL

curl --request GET \
  --url https://api.siftstack.com/api/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'

200

{
  "campaign": {
    "campaignId": "<string>",
    "name": "<string>",
    "isArchived": true,
    "organizationId": "<string>",
    "clientKey": "<string>",
    "description": "<string>",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "archivedDate": "2023-11-07T05:31:56Z",
    "tags": [
      {
        "tagId": "<string>",
        "name": "<string>"
      }
    ],
    "reports": [
      {
        "reportId": "<string>",
        "reportName": "<string>",
        "numAnnotations": 123,
        "numPassedRules": 123,
        "numAcceptedRules": 123,
        "numFailedRules": 123,
        "numOpenRules": 123
      }
    ],
    "createdFromCampaignId": "<string>",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z",
          "isArchived": true
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "relationValue": {
          "resourceType": "<string>",
          "resourceId": "<string>"
        },
        "archivedDate": "2023-11-07T05:31:56Z",
        "isArchived": true
      }
    ],
    "reportsIncludeSummaries": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId · string · required

Query Parameters

clientKey · string

organizationId · string

skipReportSummaries · boolean

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

200

application/json

A successful response.

The response of a call to CampaignService_GetCampaign to retrieve a campaign.

campaign · object · required

Show child attributes