Get a campaign

GET /campaign/{id}

Path parameters

id string Required

The campaign ID

Responses

200

The campaign retrieved from the request
Hide response attributes Show response attributes object
- campaignId string Required
  
  The unique identifier of a campaign
- name string Required
- description string Required
- business object Required
- startDate object Required
- endDate object
- geo array Required
- files array Required
- status string
- reporting string
- timestamp number
400

Client error
Hide response attribute Show response attribute object
- message string Required
  
  A human readable error message

GET /campaign/{id}

curl \
 -X GET https://api.spotlumos.com/campaign/{id} \
 -H "X-API-KEY: $API_KEY"

Response examples (200)

{
  "campaignId": "string",
  "name": "string",
  "description": "string",
  "business": {},
  "startDate": {},
  "endDate": {},
  "geo": [],
  "files": [],
  "status": "string",
  "reporting": "string",
  "timestamp": 42.0
}

Response examples (200)

{
  "campaignId": "string",
  "name": "string",
  "description": "string",
  "business": {},
  "startDate": {},
  "endDate": {},
  "geo": [],
  "files": [],
  "status": "string",
  "reporting": "string",
  "timestamp": 42.0
}

Response examples (400)

{
  "message": "string"
}

Response examples (400)

{
  "message": "string"
}