flagship campaign
Manage your campaigns
flagship campaign create
NAME
flagship campaign create
- Create a campaign
SYNOPSIS
flagship campaign create [-d DATA_RAW | --data-raw=DATA_RAW ]
DESCRIPTION
Create a campaign in your account
EXAMPLES
Fill the project_id
Make sure to fill the correct project_id for the example
flagship campaign create -d DATA_RAW
flagship campaign create -d "{\"project_id\":\"<PROJECT_ID>\",\"name\":\"test_campaign\",\"description\":\"<DESCRIPTION>\",\"type\":\"ab\",\"variation_groups\":[{\"variations\":[{\"name\":\"VARIATION_NAME\",\"allocation\":50,\"reference\":true}]}]}"
flagship campaign create -d "{\"project_id\":\"<PROJECT_ID>\",\"name\":\"test_campaign\",\"description\":\"<DESCRIPTION>\",\"type\":\"ab\",\"variation_groups\":[{\"variations\":[{\"name\":\"VARIATION_NAME\",\"allocation\":50,\"reference\":true,\"modifications\":{\"value\":{\"color\":\"blue\"}}},{\"name\":\"VARIATION_NAME1\",\"allocation\":50,\"reference\":false,\"modifications\":{\"value\":{\"color\":\"red\"}}}],\"targeting\":{\"targeting_groups\":[{\"targetings\":[{\"operator\":\"CONTAINS\",\"key\":\"TARGETING_KEY\",\"value\":\"TARGETING_KEY_VALUE\"}]}]}}],\"scheduler\":{\"start_date\":\"2023-04-01 10:00:00\",\"stop_date\":\"2024-01-01 08:00:00\",\"timezone\":\"Europe/Paris\"},\"primary_goal\":{\"type\":\"event\",\"label\":\"GOAL_LABEL_PRIM\"},\"secondary_goals\":[{\"type\":\"event\",\"label\":\"GOAL_LABEL_SEC\"}]}"
REQUIRED FLAGS
--data-raw = DATA_RAW
The raw data contains all the info to create your campaign, check the Remote Control API documentation for more details (Check also Shell - Example)
Raw data format
Note that you should insert data without spaces, line breaks, tabulation etc...
flagship campaign list
NAME
flagship campaign list
- List all campaigns
SYNOPSIS
flagship campaign list [--output-format = OUTPUT_FORMAT [table|json|json-pretty]]
DESCRIPTION
List all campaigns in your account
EXAMPLES
flagship campaign list
FLAGS
--output-format = OUTPUT_FORMAT
The output format for printing command output resources. The default is table. The supported formats are: json-pretty, table, json.
flagship campaign get
NAME
flagship campaign get
- Get a campaign
SYNOPSIS
flagship campaign get [-i CAMPAIGN_ID | --id = CAMPAIGN_ID]
DESCRIPTION
Get a campaign in your project
EXAMPLES
flagship campaign get -i CAMPAIGN_ID
REQUIRED FLAGS
--id = CAMPAIGN_ID
The id of the campaign you want to display
FLAGS
--output-format OUTPUT_FORMAT
The output format for printing command output resources. The default is table. The supported formats are: json-pretty, table, json.
flagship campaign edit
NAME
flagship campaign edit
- Edit a campaign
SYNOPSIS
flagship campaign edit [-i CAMPAIGN_ID | --id = CAMPAIGN_ID] [-d DATA_RAW | --data-raw=DATA_RAW ]
DESCRIPTION
Edit a campaign in your project
EXAMPLES
flagship campaign edit -i CAMPAIGN_ID -d DATA_RAW
REQUIRED FLAGS
--id = CAMPAIGN_ID
The id of the campaign you want to edit
--data-raw = DATA_RAW
The raw data contains all the info to edit your campaign, check the Remote Control API documentation for details
Raw data format
Note that you should insert data without spaces, line breaks, tabulation etc...
flagship campaign delete
NAME
flagship campaign delete
- Delete a campaign
SYNOPSIS
flagship campaign delete [-i CAMPAIGN_ID | --id = CAMPAIGN_ID]
DESCRIPTION
Delete a campaign in your project
EXAMPLES
flagship campaign delete -i CAMPAIGN_ID
REQUIRED FLAGS
--id = CAMPAIGN_ID
The id of the campaign you want to delete
flagship campaign switch
NAME
flagship campaign switch
- Switch a campaign status
SYNOPSIS
flagship campaign switch [-i CAMPAIGN_ID | --id = CAMPAIGN_ID] [-s STATUS | --status = STATUS [active, paused, interrupted]]
DESCRIPTION
Switch a campaign status in your project
EXAMPLES
flagship campaign switch -i CAMPAIGN_ID -s STATUS
REQUIRED FLAGS
--id = CAMPAIGN_ID
The id of the campaign you want to change status
--status = STATUS
The status you want to set to the campaign. Only 3 values are possible: active, paused, and interrupted
Updated 3 days ago