Page Load

Create a Page Load

post

Submits a page load or app open event. This should be triggered when a user lands on a tracked page or opens a mobile app via a tracking link. It returns the clickId and landingPage URL for deep linking.

Body

application/x-www-form-urlencoded

CampaignIdintegerRequired

Unique identifier for your program.

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

ISO 8601 format of the event time.

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

ReferringUrlstring · uriOptional

URL of the referring website.

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

CustomProfileIdstringRequired

Anonymous user identifier. 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 unique non-PII customer identifier.

Example: BCZ2WVSH674563PDPYOTM3AXDQ

CustomerEmailstringOptional

SHA-1 hashed email address.

Example: [e-mail]

TrackingConsentbooleanOptional

User tracking consent status.

Example: true

UserAgentstringOptional

User agent of the customer, used to provide device reporting. Primarily used for web traffic. See DeviceMfr and DeviceModel for the equivalent for in-app requests.

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

AppleIfvstringOptional

Apple ID for Vendors (IDFV).

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

IpAddressstringOptional

IP address of the customer. The IP address is used to help the system identify fraudulent activity. The IP address can be used for attribution in the case of installs.

Example: 72.194.216.61

AppNamestringOptional

Name of the mobile app. Only for mobile events.

Example: Acme App

AppPackagestringOptional

Package name for the mobile app the user installed. Only for mobile events.

Example: com.acme.app

AppVerstringOptional

Version of the mobile app. Only for mobile events.

Example: 1.2.3

DeviceMfrstringOptional

Mobile device's manufacturer. impact.com expects this to be passed in a specific format—refer to the code below that needs to be included in your mobile app to capture the value in the appropriate format.

Example: Apple

DeviceModelstringOptional

Mobile device's model. impact.com expects this to be passed in a specific format—refer to the code below that needs to be included in your mobile app to capture the value in the appropriate format.

Example: iPhone 15

Responses

200

Successfully tracked the event. The response contains tracking data such as clickId, and may include landingPage, sessionStart, or warnings.

application/json

or

or

400

The request was invalid due to missing or malformed parameters. The response contains an errors object.

application/json

post/PageLoad

HTTPcURLJavaScriptPython

POST /PageLoad HTTP/1.1
Host: trkapi.impact.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 679

"CampaignId=1000&PageUrl='https://www.acme.com/products/tennis-balls'&PropertyId=12345&AppleIfa='38400000-8cf0-11bd-b23e-10b96e40000d'&GoogAId='38400000-8cf0-11bd-b23e-10b96e40000d'&EventDate='2026-09-10T22:55:32-08:00'&ReferringUrl='https://www.google.com/'&CustomProfileId='a1b2c3d4e5f6'&CustomerId='BCZ2WVSH674563PDPYOTM3AXDQ'&CustomerEmail='[e-mail]'&TrackingConsent=true&UserAgent='Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36'&AppleIfv='38400000-8cf0-11bd-b23e-10b96e40000d'&IpAddress='72.194.216.61'&AppName='Acme App'&AppPackage='com.acme.app'&AppVer='1.2.3'&DeviceMfr='Apple'&DeviceModel='iPhone 15'"

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