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 email

Retrieve an affiliate by Email

Unarchive an affiliate

Archive affiliate

Reject an affiliate

Approve an affiliate

Update affiliate information

Returns the affiliate with the given affiliate code.

Retrieve an affiliate by Affiliate Code

Returns a paginated list of affiliates with their associated links.

List all affiliates

Retrieve total number of affiliates

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

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

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

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

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>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

The Purchases section of the LeadDyno REST API 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.

The Purchases section of the LeadDyno REST API 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.

Creates a new purchase entry in your LeadDyno account.

Creates a new purchase entry in your LeadDyno account.

The email address of the customer who made the purchase.

email

A unique identifier for this purchase. If not provided, a unique ID will be generated.

purchase_code

The total amount of the purchase, used for percentage commission calculations. This parameter is optional.

purchase_amount

The code of the reward structure used for calculating affiliate commissions.

plan_code

The affiliate code to which the purchase should be assigned. This parameter is optional and its usage depends on the 'first source wins' or 'first affiliate wins' settings.

code

An overriding commission amount that will replace any predefined plan and provide an immediate fixed-amount commission. This value should be a decimal.

commission_amount_override

description

If set to false, the original affiliate of the lead will be retained. Default value is true.

reassign_affiliate

JSON object containing the line items associated with the purchase. This parameter is optional.

line_items

Content-Type

created_at

updated_at

cancelled

currency

note

cancellation

lead

affiliate

plan

Retrieve detailed information about a specific purchase by its unique identifier. Users have the option to include line items (SKUs) for a detailed view of the purchase details.

Retrieve detailed information about a specific purchase by its unique identifier. Users have the option to include line items (SKUs) for a detailed view of the purchase details. 

Set this parameter to true to include detailed information about the line items (SKUs) associated with the purchase. The default value is false.

include_line_items

The date and time of the last update to the purchase details

Indicates if the purchase has been cancelled

Additional notes or comments related to the purchase

The modified commission amount for the purchase

This section allows users to retrieve detailed information about a purchase using its unique purchase code. By optionally including line items, users can gain a comprehensive view of the items included in the purchase.

This section allows users to retrieve detailed information about a purchase using its unique purchase code. By optionally including line items, users can gain a comprehensive view of the items included in the purchase.

A unique identifier (purchase code) associated with the purchase to be retrieved.

When set to true, detailed information on the line items (SKUs) related to the purchase will be included. Default value is false.

This endpoint allows users to get detailed information about the commissions associated with a specific purchase ID.

This endpoint allows users to get detailed information about the commissions associated with a specific purchase ID.

Specifies the page number for pagination. Each page consists of up to 10 records, with the default page set to 1.

page

Retrieve the total number of purchases.

count

Returns a paginated list of purchases.

Specifies the page number for retrieving paginated results. Each page contains up to 100 records. Default: 1.

Filters purchases to include only those created after the specified timestamp. The filter is exclusive, meaning it will not include purchases created exactly at the specified time. Format: ISO 8601 (e.g., 2024-09-24T12:26:00Z).

created_after

Filters purchases to include only those created before the specified timestamp. The filter is exclusive, meaning it will not include purchases created exactly at the specified time. Format: ISO 8601 (e.g., 2024-09-24T12:28:00Z).

created_before

If set to true, includes detailed information about the line items (SKUs) for each purchase in the response. Default: false.

If set to true, returns only purchases referred by affiliates. Default: false.

affiliates_only

This section allows users to cancel a specific purchase.

This section allows users to cancel a specific purchase. 

source

effective_date

cancellation_code

This section allows users to cancel a purchase either by providing the customer's email address or the purchase code. This action enables users to efficiently manage and update their purchase records within the system. Additionally, users can include optional parameters, such as a custom cancellation code or an effective date, to further customize the cancellation process.

This section allows users to cancel a purchase either by providing the customer's email address or the purchase code. This action enables users to efficiently manage and update their purchase records within the system. Additionally, users can include optional parameters, such as a custom cancellation code or an effective date, to further customize the cancellation process.

The email address of the customer who made the purchase. Required if `purchase_code` is not provided.

The unique identifier of the purchase to be cancelled. Required if `email` is not provided.

A user-defined string indicating the origin or reason for the cancellation. Optional.

The effective date of the cancellation. Defaults to the current date and time if not provided.

A custom cancellation code. If not provided, a system-generated code will be assigned.

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

This section allows users to manage and track their marketing campaigns efficiently. With this functionality, users can create, monitor, and analyze the performance of their campaigns to optimize their marketing efforts and drive better results.

This section allows users to manage and track their marketing campaigns efficiently. With this functionality, users can create, monitor, and analyze the performance of their campaigns to optimize their marketing efforts and drive better results.

The Campaigns section allows users to manage and track their marketing campaigns efficiently. With this functionality, users can create, monitor, and analyze t

The Custom Fields section allows users to define and manage custom fields within the LeadDyno. By utilizing this section, users can customize their data structures and collect specific information tailored to their business needs. This section empowers users to enhance the flexibility and functionality of their LeadDyno integration.

The Custom Fields section allows users to define and manage custom fields within the LeadDyno. By utilizing this section, users can customize their data structures and collect specific information tailored to their business needs. This section empowers users to enhance the flexibility and functionality of their LeadDyno integration.

This section allows users to retrieve detailed information about the affiliate links, Sub IDS.

This section allows users to retrieve detailed information about the affiliate links, Sub IDS.

The Sub IDs section allows users to retrieve detailed information about the affiliate links, Sub IDS.