IMimpact
Tracking

Track a Page Load or App Open

Tracks a user session start, either from a web page load or a mobile app open. This endpoint returns a clickId which should be captured and can be used later to attribute a conversion.

post/PageLoad

Request

Request body application/x-www-form-urlencoded

CampaignIdinteger required

Unique identifier for your program (campaign).

PageUrlstring uri required

Required. Destination URL that is intercepted by the app.

  • If the app open occurs from an impact.com tracking link, send the full tracking link (e.g., https://mysite.pxf.io/c/1234567/12345/1234?sharedid=abcd).
  • If the app is opened directly (e.g., not redirected from a URL), do not send any value.
  • If the app open occurs from a non-Impact URL, send the actual URL with https: (e.g., https://www.example.com?name=value).
  • If the app open occurs using a custom URI scheme, send the full URI (e.g., app://view?sharedid=abcd).

Tip: When testing clicks and events, append ?impacttest=1 to your PageUrl.

PropertyIdinteger

Required for mobile/app opens. For mobile app opens, this value is the "System App ID" of your app in impact.com. Found in Settings → Mobile Apps.

AppleIfastring

Required for iOS app opens. Apple ID for Advertising (IDFA) associated with the mobile device the customer converted on. Used for attribution purposes. Typically only available for iOS in-app conversions.

GoogAIdstring

Required for Android app opens. Google Advertising ID associated with the mobile device the customer converted on. Used for attribution purposes. Typically only available for Android in-app conversions.

EventDatestring date-time required

The timestamp of the event in ISO 8601 format.

ReferringUrlstring uri

The URL of the website that originated the click.

CustomProfileIdstring required

Your unique identifier for an anonymous website visitor. If CustomProfileId is not provided, please provide at least one of the following identifiers: GoogAId, AndroidId, AppleIfa, AppleIfv, ClickId, or CustomerId.

CustomerIdstring

Your non-PII unique identifier for the customer.

CustomerEmailstring

Customer's email address (plain text or SHA1 hashed).

TrackingConsentboolean

Indicates if the user has provided consent to be tracked.

UserAgentstring

The user agent string of the browser or device.

AppleIfvstring

Apple ID for Vendors (IDFV), for iOS apps.

IpAddressstring

Public IP address of the user.

AppNamestring

Name of the mobile app.

AppPackagestring

Package name/bundle ID of the mobile app.

AppVerstring

Version of the mobile app.

DeviceMfrstring

Manufacturer of the mobile device (e.g., "Apple").

DeviceModelstring

Model of the mobile device (e.g., "iPhone13,2").

Response

Successfully tracked the event. The response will contain a clickId and either a landingPage or sessionStart. It may also include warnings.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.