List of Beacons
GET {{campaign_url}}/beacons?advertiserId={{advertiserId}}&offset=0&limit=2&sortOrder=asc&sortKey=beaconPlacement
Retrieve a list of beacons
You can retrieve all of the beacons within a specified market or advertiser by sending this GET request.
Note: marketId and advertiserId cannot be used at the same time for a single request.
If you want to view all beacons under a given market and have access to multiple markets, you must specify a value for marketId.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
marketId | number | Limits response results to beacons within the market specified. |
Cannot be defined when advertiserId is defined. |
| advertiserId | string | | Limits response results to beacons under the advertiser specified. If left unchecked/empty, beacons under all advertisers are returned.
Cannot be defined when marketId is defined. |
| offset | number | | The starting index in the list of beacons. |
| limit | number | | The number of beacons to return. |
| sortOrder | string | | Direction by which results should be sorted.
Allowed values: asc, desc |
| sortKey | string | | Field by which results should be sorted.
Allowed values: id, name, beaconPlacement |
RESPONSES
status: OK
{"queryTotal":5,"data":[{"id":"1608770955","marketId":"1","resourceType":"beacon","advertiserId":"1608767822","createdAt":"2022-08-18T05:15:06Z","updatedAt":"2022-08-18T05:17:01Z","isMobileActionTrackingEnabled":false,"beaconPlacement":"homepage","name":"test beacon","workflowStatus":"archived","acceptedAction":"click","clickAssociationWindow":30,"viewAssociationWindow":{"period":1,"periodUnits":"days"},"actionCap":50,"includeShoppingCartValue":true,"tatCategory":"legal_familyLaw_childSupport","trackingMethod":"atlas","thirdPartyRedirectUrl":"https://amobee.com","isBeaconValidated":true,"pageProtocol":"https","beaconJavascriptCode":"\u003c!-- Do Not Remove - Turn Tracking Beacon Code - Do Not Remove --\u003e\n\u003c!-- Advertiser Name : doc team test --\u003e\n\u003c!-- Beacon Name : test beacon --\u003e\n\u003c!-- If Beacon is placed on a Transaction or Lead Generation based page, please populate the turn_client_track_id with your order/confirmation ID --\u003e\n\u003cscript type=\"text/javascript\"\u003e\n turn_beacon_price = \"\";\n turn_client_track_id = \"\";\n\u003c/script\u003e\n\u003cscript type=\"text/javascript\" src=\"https://r.turn.com/server/beacon_call.js?b2=aJyDuX4SYQknBRbW22OfTbZJrvUjl739qSL8T7S2750qGnabRXntGmmNbV_HpslFwd6kCs27LkY6ixT222Hv0g\"\u003e\n\u003c/script\u003e\n\u003cnoscript\u003e\n \u003cimg border=\"0\" src=\"https://r.turn.com/r/beacon?b2=aJyDuX4SYQknBRbW22OfTbZJrvUjl739qSL8T7S2750qGnabRXntGmmNbV_HpslFwd6kCs27LkY6ixT222Hv0g\u0026cid=\u0026bprice=\"\u003e\n\u003c/noscript\u003e\n\u003c!-- End Turn Tracking Beacon Code Do Not Remove --\u003e","gdprConsent":false,"ccpaConsent":false,"beaconImageCode":"\u003cimg border=\"0\" src=\"https://r.turn.com/r/beacon?b2=aJyDuX4SYQknBRbW22OfTbZJrvUjl739qSL8T7S2750qGnabRXntGmmNbV_HpslFwd6kCs27LkY6ixT222Hv0g\u0026cid=\u0026bprice=\"\u003e"},{"id":"1608770956","marketId":"1","resourceType":"beacon","advertiserId":"1608767822","createdAt":"2022-08-18T05:17:09Z","updatedAt":"2022-08-18T05:19:02Z","isMobileActionTrackingEnabled":false,"beaconPlacement":"homepage","name":"test beacon","workflowStatus":"archived","acceptedAction":"click","clickAssociationWindow":30,"viewAssociationWindow":{"period":1,"periodUnits":"days"},"actionCap":50,"includeShoppingCartValue":true,"tatCategory":"legal_familyLaw_childSupport","trackingMethod":"atlas","thirdPartyRedirectUrl":"https://amobee.com","isBeaconValidated":true,"pageProtocol":"https","beaconJavascriptCode":"\u003c!-- Do Not Remove - Turn Tracking Beacon Code - Do Not Remove --\u003e\n\u003c!-- Advertiser Name : doc team test --\u003e\n\u003c!-- Beacon Name : test beacon --\u003e\n\u003c!-- If Beacon is placed on a Transaction or Lead Generation based page, please populate the turn_client_track_id with your order/confirmation ID --\u003e\n\u003cscript type=\"text/javascript\"\u003e\n turn_beacon_price = \"\";\n turn_client_track_id = \"\";\n\u003c/script\u003e\n\u003cscript type=\"text/javascript\" src=\"https://r.turn.com/server/beacon_call.js?b2=RyrLxxDHCGfZU9bUVgGetTVC5aEBm1mPnTBaBJdUCigqGnabRXntGmmNbV_HpslFgLdern0nt8ARqnIA1n77cQ\"\u003e\n\u003c/script\u003e\n\u003cnoscript\u003e\n \u003cimg border=\"0\" src=\"https://r.turn.com/r/beacon?b2=RyrLxxDHCGfZU9bUVgGetTVC5aEBm1mPnTBaBJdUCigqGnabRXntGmmNbV_HpslFgLdern0nt8ARqnIA1n77cQ\u0026cid=\u0026bprice=\"\u003e\n\u003c/noscript\u003e\n\u003c!-- End Turn Tracking Beacon Code Do Not Remove --\u003e","gdprConsent":false,"ccpaConsent":false,"beaconImageCode":"\u003cimg border=\"0\" src=\"https://r.turn.com/r/beacon?b2=RyrLxxDHCGfZU9bUVgGetTVC5aEBm1mPnTBaBJdUCigqGnabRXntGmmNbV_HpslFgLdern0nt8ARqnIA1n77cQ\u0026cid=\u0026bprice=\"\u003e"}],"errors":[],"links":{"self":"https://services.amobee.com/campaign/v5/api/beacons?advertiserId=1608767822\u0026offset=0\u0026limit=2\u0026sortOrder=asc\u0026sortKey=id","next":"https://services.amobee.com/campaign/v5/api/beacons?advertiserId=1608767822\u0026offset=2\u0026limit=2\u0026sortOrder=asc\u0026sortKey=id"}}