curl --request GET \
--url https://apix.us.amity.co/api/v1/ads/me \
--header 'Authorization: Bearer <token>'
{
"ads": [
{
"adId": "<string>",
"advertiserId": "<string>",
"name": "<string>",
"placements": [
"feed"
],
"headline": "<string>",
"description": "<string>",
"body": "<string>",
"image1_1": "<string>",
"image9_16": "<string>",
"callToAction": "<string>",
"callToActionUrl": "<string>",
"targets": {
"communityIds": [
"<string>"
]
},
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"advertisers": [
{
"advertiserId": "<string>",
"name": "<string>",
"companyName": "<string>",
"avatarFileId": "<string>",
"adsCount": 0,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"settings": {
"enabled": true,
"maxActiveAds": 500,
"frequency": {
"feed": {
"type": "fixed",
"value": 5
},
"story": {
"type": "fixed",
"value": 4
},
"comment": {
"type": "fixed",
"value": 10
}
}
}
}
curl --request GET \
--url https://apix.us.amity.co/api/v1/ads/me \
--header 'Authorization: Bearer <token>'
{
"ads": [
{
"adId": "<string>",
"advertiserId": "<string>",
"name": "<string>",
"placements": [
"feed"
],
"headline": "<string>",
"description": "<string>",
"body": "<string>",
"image1_1": "<string>",
"image9_16": "<string>",
"callToAction": "<string>",
"callToActionUrl": "<string>",
"targets": {
"communityIds": [
"<string>"
]
},
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"advertisers": [
{
"advertiserId": "<string>",
"name": "<string>",
"companyName": "<string>",
"avatarFileId": "<string>",
"adsCount": 0,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"accessType": "public",
"altText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"attributes": {
"name": "<string>",
"extension": "<string>",
"size": 123,
"mimeType": "<string>",
"metadata": {
"exif": {},
"gps": {},
"height": 123,
"width": 123,
"isFull": true
}
}
}
],
"settings": {
"enabled": true,
"maxActiveAds": 500,
"frequency": {
"feed": {
"type": "fixed",
"value": 5
},
"story": {
"type": "fixed",
"value": 4
},
"comment": {
"type": "fixed",
"value": 10
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
All ads information and ads settings
Query ads response payload