Returns a list of your unique URLs.
Parameters
CampaignId
optional
CampaignId
optionalId of the program (formerly known as campaign) that hosts the unique URL.
State
optional
State
optionalState of the unique URL.
View possible enum values | |
---|---|
AVAILABLE | Unique URL is available for assignment. |
DELETED | Unique URL has been deleted. |
INUSE | Unique URL is currently being used by a partner. |
QUARANTINE | Unique is quarantined and is being investigated. |
RESERVED | Unique URL is reserved for a certain partner. |
Returns
Returns an array of unique URL objects up to a limit dictated by @pagesize
. Each entry in the array is a separate unique URL. If no unique URLs meet the criteria, the resulting array will be empty. This request should never return an error.
Example Request
curl 'https://api.impact.com/Advertisers/<AccountSID>/UniqueUrls' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-d 'CampaignId=1000' \
-d 'State=AVAILABLE' \
-G
Example Response
{
"@page": "1",
...
"UniqueUrls": [
{
"Id": "00005",
"Url": "https://impact.com",
"LandingPage": "https://impact.com",
"CampaignId": "1000",
"CampaignName": "Acme Campaign",
"State": "AVAILABLE",
"MediaPartnerId": "10000",
"MediaPartnerName": "Acme Partner",
"DateCreated": "2020-09-18T19:17:36-04:00",
"DateLastAssigned": "",
"DateLastReleased": "",
"Uri": "/Advertisers/<AccountSID>/UniqueUrls/00005"
},
...
]
}