API Reference

The unique URL object

The unique URL object holds information about a unique URL a partner can have access to. You can retrieve a unique URL as well as list all unique URLs.

Attributes

Id integer

Unique identifier for the object referred to as the impact.com Unique URL Object.

Url string

Unique URL a partner can have access to.

LandingPage string

Landing page that the unique URL points to.

CampaignId integer

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

CampaignName string

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

State enum

State of the unique URL.

View possible enum values
AVAILABLEUnique URL is available for assignment.
DELETEDUnique URL has been deleted.
INUSEUnique URL is currently being used by a partner.
QUARANTINEUnique is quarantined and is being investigated.
RESERVEDUnique URL is reserved for a certain partner.

MediaPartnerId integer

Id of the partner (formerly known as media partner) the unique URL is assigned to.

MediaPartnerName string

Name of the partner (formerly known as media partner) the unique URL is assigned to.

DateCreated string

Date and time the unique URL was created. See ISO 8601.

DateLastAssigned string

Date and time the unique URL was last assigned to a partner. See ISO 8601.

DateLastReleased string

Date and time the unique URL was last released from a partner. See ISO 8601.

Uri string

Unique URL's direct URI to view only one specific unique URL.

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