LeadDyno

API for tracking web traffic and managing an affiliate program.

LeadDyno API

Authentication

Errors

Affiliates

Creates a new affiliate. The affiliate can include custom fields, compensation tiers, and optionally be linked to a referring affiliate (MLM).

Create a new affiliate

Returns the total commission data (due, pending, paid, and total) in the default currency for a specific affiliate.

Retrieve commissions for a specific affiliate filtering by status

Retrieve total commissions for a specific affiliate

Returns the purchases associated with the affiliate.

Retrieve purchases by affiliate

Returns the leads associated with the affiliate.

Retrieve leads associated with an affiliate

Retrieve an affiliate by ID

Returns the affiliate with the given affiliate code.

Retrieve an affiliate by Affiliate Code

Returns the affiliate with the given email

Retrieve an affiliate by Email

Retrieve total number of affiliates

Returns a paginated list of affiliates with their associated links.

List all affiliates

Unarchive an affiliate

Archive affiliate

Reject an affiliate

Approve an affiliate

Update affiliate information

Purchases

Creates a new purchase and assigns it to an affiliate if applicable. If the lead already exists and `reassign_affiliate` is set to false, the affiliate for the existing lead will be preserved.

Create a purchase

Returns the purchase with the given ID. Optionally includes line items.

Retrieve a purchase by ID

Update a purchase

Returns the purchase with the given purchase code. Optionally includes line items.

Retrieve a purchase by purchase code

Retrieve purchase commissions

Retrieve total purchase count

Returns a paginated list of all purchases.

List all purchases

Cancel a purchase by ID

Cancels a purchase based on either the email or purchase code. If an email is not provided, it will be derived from the purchase code.

Cancel a purchase by purchase code or customer email

Approve a purchase by ID

Reject a purchase by ID

Commissions

Creates a new commission for the affiliate.

Create an affiliate commission

Returns the commissions associated with the affiliate.

Retrieve commissions by affiliate ID

Returns commission totals within the specified date range.

Retrieve commission totals

Returns a paginated list of all commissions.

List all commissions

Mark commissions for a specific purchase and affiliate as paid.

Mark affiliate commissions as paid

Cancel affiliate commissions

Leads

Create a lead

Retrieve a lead by ID

Returns the lead with the given email address.

Retrieve a lead by email

Retrieve total lead count

Returns a paginated list of purchases associated with the lead. Optionally includes line items.

Retrieve purchases for a lead

Returns a paginated list of leads, 100 per page.

List all leads

Allows updating a lead's email, first name, last name, and custom status.

Update a lead

Cancels all purchases associated with the given lead.

Cancel all purchases for a lead

Visitors

Create a visitor

Retrieve a visitor by ID

Returns the visitor with the given tracking code.

Retrieve a visitor by tracking code

Retrieve total visitor count

Returns a paginated list of visitors, 100 per page.

List all visitors

Campaigns

Returns the leads associated with the campaign.

Retrieve Campaign Leads

Retrieve Campaign by ID

Retrieve total campaign count

List all campaigns

Custom Fields

Create Custom Fields for Affiliates

Delete custom fields

Retrieve custom fields

Sub IDs

Create a Sub ID

Retrieve a Sub ID for a specific affiliate

Returns a paginated list of Sub IDs for an affiliate.

List Sub IDs for an Affiliate

Deletes a Sub ID for an affiliate by archiving it.

Archive Affiliate Sub ID

Highlighted Links

List Highlighted Links for an Affiliate

Default

LeadDyno REST API

Explore the comprehensive LeadDyno REST API documentation to seamlessly integrate and manage affiliate tracking. Access detailed guides on endpoints, authentication, data management, and more.

LeadDyno REST API Documentation

Production

Sandbox

This section allows users to track web traffic and effectively manage their affiliate program. By utilizing this API, users can gain valuable insights into their website traffic and enhance their affiliate marketing strategies.<h2 class="slate-h2 " >Just getting started?</h2>Check out our <a href="https://support.leaddyno.com/hc/en-us/articles/21508238902173-Getting-Started-with-LeadDyno-API-Tracking" target="_blank">guide</a>

This section allows users to track web traffic and effectively manage their affiliate program. By utilizing this API, users can gain valuable insights into their website traffic and enhance their affiliate marketing strategies.

The LeadDyno REST API allows users to track web traffic and effectively manage their affiliate program.

This section allows users to manage and track affiliate relationships within their program. By utilizing this section, users can view, add, update, and remove affiliates, as well as access performance metrics and commission details. This section provides essential functionality for effectively managing affiliate partnerships and tracking the success of their referral activities.

This section allows users to manage and track affiliate relationships within their program. By utilizing this section, users can view, add, update, and remove affiliates, as well as access performance metrics and commission details. This section provides essential functionality for effectively managing affiliate partnerships and tracking the success of their referral activities.

The Affiliates section allows users to manage and track affiliate relationships within their program. By utilizing this section, users can view, add, update, an

This section allows users to create a new affiliate within the LeadDyno system. Users can input details such as email, name, custom code, PayPal information, and referral affiliations.

This section allows users to create a new affiliate within the LeadDyno system. Users can input details such as email, name, custom code, PayPal information, and referral affiliations. 

email

first_name

last_name

A custom affiliate code for the new affiliate.

affiliate_code

The PayPal email address for affiliate payouts.

paypal_email

Indicates whether the affiliate is unsubscribed from communications.

unsubscribed

affiliate_type

If set to true, the affiliate will not require approval.

override_approval

The email of the affiliate who referred the new affiliate (MLM).

referring_affiliate

referring_affiliate_id

created_at

updated_at

status

archived

pending_approval

affiliate_url

affiliate_dashboard_url

compensation_tier_code

custom_fields

referrer_domain

total_leads

total_visitors

total_purchases

Retrieve all commissions for a specific affiliate filtering by status.

Retrieve all commissions for a specific affiliate filtering by status.

The page number for pagination. Defaults to 1.

page

The number of records per page. (Default: 20 | Maximum: 200)

per_page

Filters commissions by status. Accepted values: cancelled (canceled commissions), paid (paid commissions), pending (awaiting approval), due (due for payment), unpaid (unpaid commissions), live (either unpaid or paid status). Omit to retrieve all commissions.

The current page number in the paginated response.

The total number of entries available that match the request criteria.

total_entries

commissions

Retrieve the total commission data (due, pending, paid, and total) in the default currency for a specific affiliate. This section allows users to view a comprehensive overview of an affiliate&apos;s commission status at a glance, making it easier to track and manage affiliate earnings effectively.

Retrieve the total commission data (due, pending, paid, and total) in the default currency for a specific affiliate. This section allows users to view a comprehensive overview of an affiliate's commission status at a glance, making it easier to track and manage affiliate earnings effectively.

currency

pending

paid

total

This section allows users to retrieve the purchases associated with a specific affiliate.

This section allows users to retrieve the purchases associated with a specific affiliate.

The page number for pagination. Defaults to 1, with 100 records per page.

This section allows users to retrieve leads associated with a specific affiliate.

This section allows users to retrieve leads associated with a specific affiliate.

This endpoint retrieves detailed information about a specific affiliate using their unique ID.

This endpoint retrieves detailed information about a specific affiliate using their unique ID.

This endpoint retrieves detailed information about a specific affiliate using their affiliate code.

This endpoint retrieves detailed information about a specific affiliate using their affiliate code.

This endpoint retrieves detailed information about a specific affiliate using their affiliate email.

This endpoint retrieves detailed information about a specific affiliate using their affiliate email.

The email address of the affiliate to retrieve.

This endpoint allows users to retrieve the total number of affiliates.

This endpoint allows users to retrieve the total number of affiliates.

count

Retrieve a paginated list of all affiliates within your LeadDyno platform.

Retrieve a paginated list of all affiliates within your LeadDyno platform.

Specifies the number of records to display per page. The default value is 100.


The string you want to find in `first_name`, `last_name`, or `email` field

query

No additional information available for this parameter.

The value associated with this parameter is the response parameter 1.

Unarchive a specific affiliate within LeadDyno. This endpoint allows users to reactivate previously archived affiliates.

Unarchive a specific affiliate within LeadDyno. This endpoint allows users to reactivate previously archived affiliates.

Archives a specific affiliate within LeadDyno. This action moves the affiliate into an inactive state.

Archives a specific affiliate within LeadDyno. This action moves the affiliate into an inactive state.

This section allows users to reject a specific affiliate within LeadDyno. Users can formally decline affiliates from participating in their affiliate program, ensuring proper management of affiliate registrations.

This section allows users to reject a specific affiliate within LeadDyno. Users can formally decline affiliates from participating in their affiliate program, ensuring proper management of affiliate registrations.

This section allows users to approve a specific affiliate within LeadDyno. Users can formally approve affiliates from participating in their affiliate program, ensuring proper management of affiliate registrations.

This section allows users to approve a specific affiliate within LeadDyno. Users can formally approve affiliates from participating in their affiliate program, ensuring proper management of affiliate registrations.

This section allows users to update the information of a specific affiliate in LeadDyno. Users can modify fields such as email, first name, last name, affiliate code, PayPal email, and other relevant details associated with the affiliate.

This section allows users to update the information of a specific affiliate in LeadDyno.  Users can modify fields such as email, first name, last name, affiliate code, PayPal email, and other relevant details associated with the affiliate.

The compensation tier (affiliate group) code for the affiliate.

The email of the affiliate that referred this affiliate (MLM).

This section allows users to retrieve detailed information about purchases made through the platform. With this functionality, users can track and manage customer transactions, gain insights into purchase patterns, and analyze sales data for informed decision-making.

This section allows users to retrieve detailed information about purchases made through the platform. With this functionality, users can track and manage customer transactions, gain insights into purchase patterns, and analyze sales data for informed decision-making.

This section allows users to retrieve detailed information about the commissions earned through their affiliate marketing program. With this functionality, users can track and manage the financial aspects of their affiliate relationships, providing insight into earnings and performance metrics.

This section allows users to retrieve detailed information about the commissions earned through their affiliate marketing program. With this functionality, users can track and manage the financial aspects of their affiliate relationships, providing insight into earnings and performance metrics.

This section allows users to manage information related to potential leads or customers. Users can retrieve details about leads, update lead information, and track the status of leads within their LeadDyno account. This functionality provides essential tools for businesses looking to effectively manage and nurture their leads.

This section allows users to manage information related to potential leads or customers. Users can retrieve details about leads, update lead information, and track the status of leads within their LeadDyno account. This functionality provides essential tools for businesses looking to effectively manage and nurture their leads.

The Leads section allows users to manage information related to potential leads or customers. Users can retrieve details about leads, update lead informati

This section allows users to manage and retrieve data related to website visitors, whether they were referred by affiliates or arrived organically. You can use these endpoints to track the journey and behavior of visitors across your website, helping to analyze performance and conversions.

This section allows users to manage and retrieve data related to website visitors, whether they were referred by affiliates or arrived organically. You can use these endpoints to track the journey and behavior of visitors across your website, helping to analyze performance and conversions.

The Visitors section allows users to manage and retrieve data related to website visitors, whether they were referred by affiliates or arrived organically. Yo

Sections