Read a campaign
GET {{baseUrl}}/marketing/v3/campaigns/:campaignGuid?startDate=<string>&endDate=<string>&properties=<string>&properties=<string>
Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startDate | string | Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. | |
| If not provided, no asset metrics will be fetched. | |||
endDate | string | End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. | |
| If not provided, no asset metrics will be fetched. | |||
properties | string | A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object, they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map. | |
properties | string | A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object, they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"assets":{"irurea":{"results":[{"id":"\u003cstring\u003e","metrics":{"culpa9":"\u003cnumber\u003e","incididunt_7":"\u003cnumber\u003e","irurebf":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","metrics":{"non__":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}},"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"do49":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e"}