Unique URLs

List All Unique URLs

get

Returns a list of your unique URLs, with options for filtering by campaign and state.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

Query parameters

CampaignIdintegerOptional

Filter by the ID of the program (campaign) that hosts the URL.

Statestring · enumOptional

Filter by the current state of the unique URL.

Possible values:

Responses

200

A paginated list of unique URL objects.

application/json

get/Advertisers/{AccountSID}/UniqueUrls

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/UniqueUrls HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of unique URL objects.

{
  "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"
    }
  ]
}

Retrieve a Unique URL

get

Retrieves the details of a single unique URL by its ID.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

UrlIdintegerRequired

The unique identifier for the URL.

Responses

200

A single unique URL object.

application/json

IdstringOptional

The unique identifier for the unique URL.

Example: 00005

Urlstring · uriOptional

The unique URL itself.

Example: https://impact.com

LandingPagestring · uriOptional

The landing page the URL redirects to.

Example: https://impact.com

CampaignIdintegerOptional

Id of the program (formerly known as campaign) that hosts the unique URL.

Example: 1000

CampaignNamestringOptional

The display name of the program.

Example: Acme Campaign

Statestring · enumOptional

State of the unique URL.

Example: AVAILABLEPossible values:

MediaPartnerIdinteger · nullableOptional

The unique identifier of the partner the URL is assigned to, if any.

Example: 10000

MediaPartnerNamestring · nullableOptional

The display name of the assigned partner.

Example: Acme Partner

DateCreatedstring · date-timeOptional

The date and time the unique URL was created.

Example: 2020-09-18T19:17:36-04:00

DateLastAssignedstring · date-time · nullableOptional

The date and time the unique URL was last assigned to a partner.

DateLastReleasedstring · date-time · nullableOptional

The date and time the unique URL was last released from a partner.

Uristring · uri-referenceOptional

The unique reference to this unique URL in the impact.com API.

Example: /Advertisers/<AccountSID>/UniqueUrls/00005

get/Advertisers/{AccountSID}/UniqueUrls/{UrlId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/UniqueUrls/{UrlId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

A single unique URL object.

{
  "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"
}