Ctrlk
Help CenterContact Support

Page Load

Track a Page Load or App Open

post

Tracks a page load or app open event. This endpoint is used to attribute credit for a conversion that results from a partner driving traffic. It does not require authentication.

Body
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

Timestamp of the event (ISO 8601) or the string 'NOW'.

Example: 2026-09-10T22:55:32-08:00
ReferringUrlstring · uriOptional

URL of the website where the click originated.

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

Your unique identifier for an anonymous visitor.

Example: a1b2c3d4e5f6
CustomerIdstringOptional

Your unique, non-PII identifier for the customer.

Example: BCZ2WVSH674563PDPYOTM3AXDQ
CustomerEmailstringOptional

Customer's email, either plaintext or SHA1 hashed.

Example: [email protected]
TrackingConsentbooleanOptional

Indicates if the user has consented to tracking.

Example: true
UserAgentstringOptional

User agent of the customer's browser.

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

Apple ID for Vendors.

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

Customer's IP address.

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

The request was successfully processed. The response will contain a clickId and potentially a landingPage URL or session information.

application/json
landingPagestring · uriOptional

The destination landing page URL. Present only when PageUrl is a gateway tracking link.

Example: https://www.mysite.com/products/145324
clickIdstringOptional

Unique click ID generated by impact.com.

Example: 0c22384eN-3765c5f900c2878068a0631b
sessionStartstring · date-timeOptional

The time when the user session started.

Example: 2026-09-10T22:55:32-08:00
post
/PageLoad

Get Deferred Deep Link Information

post

Retrieves information about a deferred deep linking event after an app install has occurred. This API call is performed when the user first opens the app.

Body
CampaignIdintegerRequired

Unique identifier for your program (or campaign ) on impact.com. Viewable in the platform by selecting your account name from the top left corner—your campaign ID is the integer in gray type under Programs section.

Example: 1000
ImpactAppIdintegerRequired

System App ID of your mobile app.

Example: 12345
EventDatestring · date-timeRequired

The date and time the app install happened (ISO 8601).

Example: 2026-09-10T22:55:32-08:00
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: 192.168.1.1
AppleIfastringOptional

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

Google Advertising Identifier. Recommended for Android.

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

Install Referrer from Google Play Store.

Example: utm_source=affiliate&utm_campaign=summer
AppPackagestringOptional

Bundle ID or package name of the app.

Example: com.acme.app
CustomProfileIdstringOptional

Unique identifier used to identify a visitor on your website (regardless of whether they're signed in). Common examples include anonymous user cookies and other anonymous user identifiers.

Example: a1b2c3d4e5f6
Responses
200

The request was processed successfully. The response will contain deep link information if a match was found.

application/json

Contains the deep link information if a match is found, along with connection details.

landingPagestring · uriOptional

URL of the web page the user was being redirected to before the app store.

clickIdstringOptional

The unique impact.com click identifier.

clickIpAddressstringOptional

IP Address captured at the time of the click.

connectionIpAddressstringOptional

IP Address captured when the connection to this endpoint is made.

post
/DeferredDeepLink
PreviousPage LoadNextModels

Last updated