LeadDyno REST API Documentation

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.

Just getting started?

Check out our guide

Production:

https://api.leaddyno.com/v1/

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

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.

Create a new commission for a specific affiliate. This endpoint allows you to set commission amounts, specify currency codes, add notes or descriptions, and set due dates.

Query Parameters

keystring Required

Your private key

Body Parameters

amountnumber (double)Required

The commission amount to be added.

currencystring

The commission currency code ('USD', 'EUR'). If not provided, the user's default currency will be used.

notestring

A note or description for the manual commission.

due_atstring (date-time)

The due date for the commission.

Response

201

Object

Creates a new commission for the affiliate.

Response Attributes

idnumber

datestring

due_atstring

amountstring

currencystring

payment_typestring

custom_singularstring

custom_pluralstring

cancelledboolean

notestring

paidboolean

purchasestring

affiliateobject

Show child attributes

curl --location 'https://api.leaddyno.com/v1/affiliates/ID/commissions?key=YOUR_PRIVATE_KEY' \
--data '{
  "amount": 9.9,
  "currency": "USD",
  "note": "Sample note commission",
  "due_at": "2024-10-15T00:00:00Z"
}'

{
  "id": 259,
  "date": "2024-10-15",
  "due_at": "2024-10-15T00:00:00Z",
  "amount": "9.9",
  "currency": "USD",
  "payment_type": "cash",
  "custom_singular": "",
  "custom_plural": "",
  "cancelled": false,
  "note": "Sample note commission",
  "paid": false,
  "purchase": null,
  "affiliate": {
    "id": 1,
    "email": "joe@foo.com"
  }
}

Retrieve commission details associated with a specific affiliate ID. Use this endpoint to access information about the commissions linked to a particular affiliate, helping track earnings and performance within your affiliate network effectively.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

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

Response

200

Object

Returns the commissions associated with the affiliate.

Response Attributes

idnumber

datestring

due_atstring

amountstring

currencystring

payment_typestring

custom_singularstring

custom_pluralstring

cancelledboolean

notestring

paidboolean

purchaseobject

Show child attributes

affiliateobject

Show child attributes

curl --location 'https://api.leaddyno.com/v1/affiliates/ID/commissions?key=YOUR_PRIVATE_KEY&page=1' \

[
  {
    "id": 769,
    "date": "2024-10-07",
    "due_at": "2024-10-07T03:00:00Z",
    "amount": "12.35",
    "currency": "USD",
    "payment_type": "cash",
    "custom_singular": "",
    "custom_plural": "",
    "cancelled": false,
    "note": null,
    "paid": true,
    "purchase": {
      "id": 1104,
      "created_at": "2024-10-07T03:00:00Z",
      "updated_at": "2024-10-16T16:52:51Z",
      "cancelled": true,
      "currency": "USD",
      "purchase_code": "0b01832c-cd02-4120-a698-1c2cd752f587",
      "note": null,
      "purchase_amount": "123.5",
      "commission_amount_override": null,
      "cancellation": {
        "id": 29,
        "cancellation_code": "eee9b192-f42a-4063-8423-1a0dca56bc80",
        "effective_date": "2024-10-16T16:52:51Z",
        "source": null
      },
      "lead": {
        "id": 2152,
        "email": "lead@email.com"
      },
      "affiliate": {
        "id": 17175,
        "email": "affiliate@email.com"
      },
      "plan": {
        "id": 30,
        "code": "default"
      }
    },
    "affiliate": {
      "id": 17175,
      "email": "affiliate@email.com"
    }
  },
  {
    "id": 820,
    "date": "2024-10-02",
    "due_at": "2024-10-02T19:01:34Z",
    "amount": "5.0",
    "currency": "USD",
    "payment_type": "cash",
    "custom_singular": "",
    "custom_plural": "",
    "cancelled": false,
    "note": null,
    "paid": true,
    "purchase": null,
    "affiliate": {
      "id": 17175,
      "email": "affiliate@email.com"
    }
  }
]

This section allows users to retrieve the total commission amounts earned within a specified date range. Users can track and analyze their commission totals over time, helping to monitor and assess their overall performance and earnings.

Query Parameters

keystring Required

Your private key

start_datestring

The start date for commission totals based on commission creation date (YYYY-MM-DD). Defaults to the beginning of time

end_datestring

The end date for commission totals based on commission creation date (YYYY-MM-DD). Defaults to the present time.

Response

200

Object

Returns commission totals within the specified date range.

Response Attributes

total_countnumber

total_cancelled_countnumber

total_due_countnumber

total_paid_countnumber

total_coststring

total_cancelled_coststring

total_due_coststring

total_paid_coststring

curl --location 'https://api.leaddyno.com/v1/commissions/totals?key=YOUR_PRIVATE_KEY&start_date=2024-10-09&end_date=2024-10-16' \

{
  "total_count": 1,
  "total_cancelled_count": null,
  "total_due_count": null,
  "total_paid_count": null,
  "total_cost": "9.9",
  "total_cancelled_cost": null,
  "total_due_cost": null,
  "total_paid_cost": null
}

Retrieve a paginated list of all commissions.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

Indicates the page number for pagination purposes. The default value is set to 1.

per_pageinteger (int32)

Specifies the number of records to display per page. The default value is 100, and the maximum allowed value is 200.

Response

200

Object

Returns a paginated list of all commissions.

Response Attributes

pagenumber

per_pagenumber

commissionsarray

Show child attributes

curl --location 'https://api.leaddyno.com/v1/commissions?key=YOUR_PRIVATE_KEY&page=1&per_page=10' \

{
  "page": 1,
  "per_page": 100,
  "commissions": [
    {
      "id": 259,
      "date": "2024-07-08",
      "due_at": "2024-07-08T16:40:05Z",
      "amount": "45.39",
      "currency": "USD",
      "payment_type": "cash",
      "custom_singular": "",
      "custom_plural": "",
      "cancelled": true,
      "note": null,
      "paid": false,
      "purchase": {
        "id": 797,
        "created_at": "2024-07-08T16:40:05Z",
        "updated_at": "2024-07-08T20:28:56Z",
        "cancelled": false,
        "currency": "USD",
        "purchase_code": "1806194101451646380",
        "note": null,
        "purchase_amount": "453.86",
        "commission_amount_override": null,
        "cancellation": null,
        "lead": {
          "id": 1797,
          "email": "lead@email.com"
        },
        "affiliate": {
          "id": 17168,
          "email": "affiliate@email.com"
        },
        "plan": {
          "id": 30,
          "code": "default"
        }
      },
      "affiliate": {
        "id": 17168,
        "email": "affiliate@email.com"
      }
    },
    {
      "id": 260,
      "date": "2024-07-08",
      "due_at": "2024-07-08T16:40:05Z",
      "amount": "45.39",
      "currency": "USD",
      "payment_type": "cash",
      "custom_singular": "",
      "custom_plural": "",
      "cancelled": false,
      "note": null,
      "paid": true,
      "purchase": {
        "id": 797,
        "created_at": "2024-07-08T16:40:05Z",
        "updated_at": "2024-07-08T20:28:56Z",
        "cancelled": false,
        "currency": "USD",
        "purchase_code": "1806194101451646380",
        "note": null,
        "purchase_amount": "453.86",
        "commission_amount_override": null,
        "cancellation": null,
        "lead": {
          "id": 1797,
          "email": "lead@email.com"
        },
        "affiliate": {
          "id": 17168,
          "email": "affiliate@email.com"
        },
        "plan": {
          "id": 30,
          "code": "default"
        }
      },
      "affiliate": {
        "id": 17168,
        "email": "affiliate@email.com"
      }
    }
  ]
}

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

Sections

LeadDyno API

Just getting started?

Language Box

cURL

Ruby

Python

PHP

Java

Node.js

Go

.NET

Affiliates

Purchases

Commissions

What made this section unhelpful for you?

Create an affiliate commission

Query Parameters

Body Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve commissions by affiliate ID

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve commission totals

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

List all commissions

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Leads

Visitors

Campaigns

Custom Fields

Sub IDs

Response

Response

Response