Get Campaign Status

curl --request POST \
  --url https://api.campaigncleaner.com/v1/get_campaign_status \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaign": {
    "id": "{{campaign_id}}"
  }
}
'

{
  "campaign_status": {
    "id": "e8c8af95-c033-11ed-9848-003048d8d536",
    "campaign_name": "Test Campaign 1",
    "status": "completed",
    "date_added": "2023-02-23T12:02:46-05:00"
  }
}

API Endpoints

Get Campaign Status

After submitting a campaign to be corrected and analyzed it can take up to a minute to finalize the results. You can check the status of your campaign with the check_campaign_status API. When you see a ‘completed’ status, you can call the get_campaign API to retrieve the results.

Header:

X-CC-API-Key: Your API Key

Request Body:

campaign:

id: The Campaign ID that you want to get the status for.

Response:

campaign_list:

id: The campaign id that will be used in other API calls.
campaign_name: The name of the campaign.
status: The status will be either processing, completed, or paused
date_added: The date and time your campaign was saved or submitted to Campaign Cleaner.

If the status is completed, you will be able to retrieve the campaign via the get_campaign API

In the event of an error, you will get an “error:” response, with a description of the reason

POST

get_campaign_status

Get Campaign Status

curl --request POST \
  --url https://api.campaigncleaner.com/v1/get_campaign_status \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaign": {
    "id": "{{campaign_id}}"
  }
}
'

{
  "campaign_status": {
    "id": "e8c8af95-c033-11ed-9848-003048d8d536",
    "campaign_name": "Test Campaign 1",
    "status": "completed",
    "date_added": "2023-02-23T12:02:46-05:00"
  }
}

Headers

X-CC-API-Key

string

Body

application/json

The body is of type object.

Response

200 - application/json

The response is of type object.

Get Campaign List Get Campaign

API Reference

Documentation Index

Headers

Body

Response