Skip to main content
GET
/
prod
/
campaign
/
{id}
Get Manual Campaign
curl --request GET \
  --url https://api.aimtell.com/prod/campaign/{id} \
  --header 'X-Authorization-Api-Key: <api-key>'
{
  "id": 259,
  "uid": "76cedd11b19e",
  "idSite": 179,
  "name": "Sample Campaign #1",
  "title": "Welcome to Aimtell!",
  "body": "Got questions? Check out our knowledge base.",
  "link": "https://kb.aimtell.com",
  "customIcon": null,
  "customImage": null,
  "segments": "245",
  "conversion_trigger": null,
  "push_ttl": 0,
  "auto_hide": null,
  "collapse_key": null,
  "schedule_date": "2024-12-11 12:12:00",
  "ab_version": null,
  "ab_linked_campaign": null,
  "push_src": null,
  "push_src_values": null,
  "tz_delivery": 0,
  "sent_date": null,
  "createdAt": "2015-12-28 17:54:42",
  "updatedAt": "2015-12-28 17:54:42",
  "automation": null,
  "automation_end": null,
  "actions": null,
  "status": 4,
  "shared_id": null,
  "clicked_a01": null,
  "clicked_a02": null,
  "schedule_pretty_time": "06:55 AM",
  "schedule_pretty_date": "12/28/2015",
  "campaign_results": {
    "sent": 27,
    "delivered": 27,
    "bounced": 0,
    "clicked": 2,
    "clicked_a01": 0,
    "clicked_a02": 0,
    "conversions": 0
  }
}

Authorizations

X-Authorization-Api-Key
string
header
default:""
required

Path Parameters

id
string
required

Campaign ID

Query Parameters

load
string

Load Additional Information (i.e. Segments)

Response

200