Tracking

Track a Page Load or App Open

post

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.

Body

application/x-www-form-urlencoded

CampaignIdintegerRequired

Unique identifier for your program (campaign).

Example: 1000

PageUrlstring · uriRequired

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.

Example: https://www.acme.com/products/tennis-balls

PropertyIdintegerOptional

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.

Example: 12345

AppleIfastringOptional

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.

Example: 38400000-8cf0-11bd-b23e-10b96e40000d

GoogAIdstringOptional

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.

Example: 38400000-8cf0-11bd-b23e-10b96e40000d

EventDatestring · date-timeRequired

The timestamp of the event in ISO 8601 format.

Example: 2026-09-10T22:55:32-08:00

ReferringUrlstring · uriOptional

The URL of the website that originated the click.

Example: https://www.google.com/

CustomProfileIdstringRequired

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.

Example: a1b2c3d4e5f6

CustomerIdstringOptional

Your non-PII unique identifier for the customer.

Example: BCZ2WVSH674563PDPYOTM3AXDQ

CustomerEmailstringOptional

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

Example: [e-mail]

TrackingConsentbooleanOptional

Indicates if the user has provided consent to be tracked.

Example: true

UserAgentstringOptional

The user agent string of the browser or device.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36

AppleIfvstringOptional

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

Example: 38400000-8cf0-11bd-b23e-10b96e40000d

IpAddressstringOptional

Public IP address of the user.

Example: 72.194.216.61

AppNamestringOptional

Name of the mobile app.

Example: Acme App

AppPackagestringOptional

Package name/bundle ID of the mobile app.

Example: com.acme.app

AppVerstringOptional

Version of the mobile app.

Example: 1.2.3

DeviceMfrstringOptional

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

Example: Apple

DeviceModelstringOptional

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

Example: iPhone 15

Responses

200

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

application/json

or

400

Bad Request. The request was invalid due to missing or malformed parameters.

application/json

post/PageLoad

cURL

curl -L \
  --request POST \
  --url 'https://api.impact.com/PageLoad' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'

{
  "landingPage": "https://www.mysite.com/products/145324",
  "clickId": "0c22384eN-3765c5f900c2878068a0631b",
  "warnings": [
    {
      "field": "CampaignId",
      "level": "ERROR",
      "message": "Invalid campaign ID (1000)"
    }
  ]
}