Skip to main content
Documentation for version v74

Get campaign information

Description​

Retrieve detailed information about a campaign, including audience settings, LCG, marketing activities and attributes.

Access rights

To use this method, the API token must have:

  • Campaigns — View object
  • Access to the groups where the campaigns are located

Configure permissions in Settings — Tokens.

Request URL​

Method: POST

https://example.com/api/v1.1/scampaigns/get

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
idint22YesCampaign ID
formatstring"json"NoResponse format
default – "json"
marketing_activitiesboolfalseNoInclude the list of marketing activities
default – false

Request example​

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 22,
  "marketing_activities": true
}

Response example​

{
  "data": [
    {
      "id": 22,
      "is_delete": false,
      "createtime": "2025-08-22T09:00:21.654Z",
      "updatetime": "2025-08-22T11:08:10.216Z",
      "updated_user": "api.user",
      "name": "Seasonal sale",
      "description": "Campaign for promoting the spring collection",
      "tags": [],
      "state": "active",
      "audience": {
        "state": "ready",
        "seg_id": 4,
        "list_id": 2,
        "extension_conf": {
          "workflows": {"ids": []},
          "triggers": {"ids": []},
          "broadcasts": {"ids": [1]},
          "regulars": {"ids": []},
          "abns": {"ids": []},
          "placements": {"ids": []}
        },
        "lcg": {
          "stratification_field_settings": [
            {
              "field_name": "_sex",
              "field_type": "enum",
              "condition_type": "list",
              "conditions": [
                {"list": [1]},
                {"list": [2]}
              ]
            },
            {
              "field_name": "_region",
              "field_type": "unicode",
              "condition_type": "list",
              "conditions": [
                {"list": ["Moscow", "Saint Petersburg"]},
                {"list": ["Kazan"]}
              ]
            }
          ],
          "ignore_entities": {
            "workflows": {"ids": []},
            "triggers": {"ids": []},
            "broadcasts": {"ids": [1]},
            "regulars": {"ids": []},
            "abns": {"ids": []},
            "placements": {"ids": []}
          },
          "size_formation_settings": {
            "limit": 133333,
            "percent": "16.00"
          }
        }
      },
      "active_period": {
        "settings": {
          "tz": "UTC",
          "end_at": "2025-08-24T12:03:21.93Z"
        },
        "history": {
          "start": "2025-08-22T09:00:47.786Z"
        }
      },
      "counters": {
        "segment": 631,
        "test_group": 530,
        "local_control_group": 101,
        "global_control_group": 0
      },
      "marketing_activities_counter": 2,
      "groups": [
        {
          "id": 0,
          "name": "main"
        }
      ],
      "attributes": {
        "season": "spring_2025",
        "branch": "marketing"
      },
      "marketing_activities": [
        {
          "workflows": [
            {
              "id": 9,
              "name": "Welcome Series",
              "is_active": true
            }
          ],
          "triggers": [
            {
              "id": 6,
              "name": "Thank You Purchase",
              "is_active": true
            }
          ],
          "broadcasts": [
            {
              "id": 1,
              "name": "Seasonal Sale Announcement",
              "is_active": true,
              "is_completed": false
            }
          ],
          "regulars": [
            {
              "id": 2,
              "name": "Weekly Newsletter",
              "is_active": true
            }
          ],
          "abns": [],
          "placements": []
        }
      ]
    }
  ],
  "error": 0,
  "error_text": "Successful operation"
}

Returned parameters​

Top-level fields​

ParameterTypeDescription
errorintError code. 0 – successful execution
error_textstringError description
dataarrayArray of campaign objects

The data object​

Contains the main campaign information.

ParameterTypeDescription
idintCampaign ID
namestringCampaign name
descriptionstringCampaign description
list_idintProfile database ID
seg_idintSegment ID
statestringCurrent campaign status
createtimestringCampaign creation date and time
updatetimestringLast update date and time
updated_userstringUser who made the last changes
is_deletebooleanDeletion flag
tagsarrayCampaign tags
groupsarrayAccess groups
marketing_activities_counterintNumber of marketing activities (mailings, scenarios, placements)
attributesobjectCampaign attributes
countersobjectProfile counters for the audience, Test group, Local and Global control groups

The counters object​

Contains profile counts for different groups.

ParameterTypeDescription
segmentintNumber of profiles in the segment
test_groupintNumber of profiles in the test group (TG)
local_control_groupintNumber of profiles in the Local control group (LCG)
global_control_groupintNumber of profiles in the Global control group (GCG) of the profile database

The active_period object​

Contains information about the campaign timeframe.

ParameterTypeDescription
settingsobjectPlanned active period settings
historyobjectActual active period data

settings

ParameterTypeDescription
tzstringCampaign time zone
start_atstringPlanned activation date
end_atstringPlanned completion date

history

ParameterTypeDescription
startstringActual activation date

The audience object

Contains campaign audience settings and information.

ParameterTypeDescription
statestringAudience building status
seg_idintCampaign segment ID
list_idintProfile database ID
extension_confobjectAudience expansion activities
lcgobjectLocal control group settings

extension_conf

Activities included in audience expansion.

ParameterTypeDescription
workflowsobjectScenarios that expand the audience
triggersobjectTriggered mailings that expand the audience
broadcastsobjectBroadcast mailings that expand the audience
regularsobjectRegular mailings that expand the audience
abnsobjectA/B tests that expand the audience
placementsobjectPlacements that expand the audience

Nested extension_conf objects

Each object contains:

ParameterTypeDescription
idsarrayActivity ID list

lcg (Local control group)

ParameterTypeDescription
stratification_field_settingsarrayStratification settings
ignore_entitiesobjectActivities that ignore LCG
size_formation_settingsobjectLCG size settings

stratification_field_settings

ParameterTypeDescription
field_namestringField name for stratification
field_typestringField type
condition_typestringCondition type for stratification
conditionsarrayStratification conditions

ignore_entities

Activities that ignore LCG audience building.

ParameterTypeDescription
workflowsobjectScenarios that ignore LCG
triggersobjectTriggers that ignore LCG
broadcastsobjectBroadcast mailings that ignore LCG
regularsobjectRegular mailings that ignore LCG
abnsobjectA/B tests that ignore LCG
placementsobjectPlacements that ignore LCG

size_formation_settings

LCG size settings.

ParameterTypeDescription
limitintLCG size limit
percentstringLCG share of the audience in percent

The marketing_activities object​

Contains the list of all campaign marketing activities.

ParameterTypeDescription
workflowsarrayScenarios
triggersarrayTriggers
broadcastsarrayBroadcasts
regularsarrayRegular mailings
abnsarrayA/B tests
placementsarrayPlacements

Common fields of marketing activities

ParameterTypeDescription
idintActivity ID
namestringMarketing activity name
is_activebooleanActivity status
is_completedbooleanCompletion status
Last updated on