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.

Creates a new purchase entry in your LeadDyno account.

Header Parameters

Content-Typestring

Query Parameters

keystring Required

Your private key

Body Parameters

emailstring Required

The email address of the customer who made the purchase.

purchase_codestring

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

purchase_amountnumber (double)

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

plan_codestring

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

codestring

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.

commission_amount_overridenumber (double)

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

descriptionstring

Text description of the purchase.

reassign_affiliateboolean

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

line_itemsarray

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

Show child attributes

Response

201

Object

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.

Response Attributes

idnumber

created_atstring

updated_atstring

cancelledboolean

currencystring

purchase_codestring

notestring

purchase_amountstring

commission_amount_overridestring

cancellationstring

leadobject

Show child attributes

affiliatestring

planobject

Show child attributes

curl --location 'https://api.leaddyno.com/v1/purchases?key=YOUR_PRIVATE_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "joe@foo.com",
  "purchase_code": "pi_abcdefghijkl",
  "purchase_amount": 100,
  "plan_code": "Default",
  "code": "joe10",
  "commission_amount_override": null,
  "description": "Monthly subscription",
  "reassign_affiliate": false,
  "line_items": {}
}'

{
  "id": 1106,
  "created_at": "2024-10-17T11:19:59Z",
  "updated_at": "2024-10-17T11:19:59Z",
  "cancelled": false,
  "currency": "USD",
  "purchase_code": "pi_abcdefghijkl",
  "note": null,
  "purchase_amount": "100.0",
  "commission_amount_override": null,
  "cancellation": null,
  "lead": {
    "id": 2154,
    "email": "joe@foo.com"
  },
  "affiliate": null,
  "plan": {
    "id": 30,
    "code": "default"
  }
}

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.

Query Parameters

keystring Required

Your private key

include_line_itemsboolean

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

Response

200

Object

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

Response Attributes

idnumber

The purchase ID

created_atstring

The purchase creation date

updated_atstring

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

cancelledboolean

Indicates if the purchase has been cancelled

currencystring

The currency used for the purchase

purchase_codestring

The unique code assigned to the purchase

notestring

Additional notes or comments related to the purchase

purchase_amountstring

The total purchase amount

commission_amount_overridestring

The modified commission amount for the purchase

cancellationobject

Show child attributes

leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

curl --location 'https://api.leaddyno.com/v1/purchases/ID?key=YOUR_PRIVATE_KEY&include_line_items=false' \

{
  "id": 1,
  "created_at": "2024-06-03T17:58:08Z",
  "updated_at": "2024-06-09T16:06:30Z",
  "cancelled": true,
  "currency": "USD",
  "purchase_code": "pi_abcdefghijkl",
  "note": null,
  "purchase_amount": "100.0",
  "commission_amount_override": null,
  "cancellation": {
    "id": 29,
    "cancellation_code": "51187950-abcdefghijkl",
    "effective_date": "2024-10-09T16:06:29Z",
    "source": null
  },
  "lead": {
    "id": 1,
    "email": "ld-preview-affiliate@leaddyno.com"
  },
  "affiliate": {
    "id": 1,
    "email": "joe@foo.com"
  },
  "plan": {
    "id": 1,
    "code": "Default"
  }
}

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.

Query Parameters

keystring Required

Your private key

purchase_codestring Required

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

include_line_itemsboolean

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

Response

200

Object

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

Response Attributes

idnumber

created_atstring

updated_atstring

cancelledboolean

currencystring

purchase_codestring

notestring

purchase_amountstring

commission_amount_overridestring

cancellationobject

Show child attributes

leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

line_itemsarray

Show child attributes

curl --location 'https://api.leaddyno.com/v1/purchases/by_purchase_code?key=YOUR_PRIVATE_KEY&purchase_code=pi_abcdefghijkl&include_line_items=false' \

{
  "id": 1,
  "created_at": "2024-06-03T17:58:08Z",
  "updated_at": "2024-06-09T16:06:30Z",
  "cancelled": true,
  "currency": "USD",
  "purchase_code": "pi_abcdefghijkl",
  "note": null,
  "purchase_amount": "100.0",
  "commission_amount_override": null,
  "cancellation": {
    "id": 29,
    "cancellation_code": "51187950-abcdefghijkl",
    "effective_date": "2024-10-09T16:06:29Z",
    "source": null
  },
  "lead": {
    "id": 1,
    "email": "ld-preview-affiliate@leaddyno.com"
  },
  "affiliate": {
    "id": 1,
    "email": "joe@foo.com"
  },
  "plan": {
    "id": 1,
    "code": "Default"
  },
  "line_items": [
    {
      "sku": "SKU-184",
      "description": "Monthly subscription.",
      "quantity": "1",
      "amount": "100.00"
    }
  ]
}

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

Query Parameters

keystring Required

Your private key

pageinteger (int32)

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

Response

200

Object

Returns the purchase commissions.

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/purchases/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": "aaffiliate@email.com"
      },
      "plan": {
        "id": 30,
        "code": "default"
      }
    },
    "affiliate": {
      "id": 17175,
      "email": "aaffiliate@email.com"
    }
  }
]

Retrieve the total number of purchases.

Query Parameters

keystring Required

Your private key

Response

200

Object

Returns the total number of purchases.

Response Attributes

countnumber

curl --location --request 'https://api.leaddyno.com/v1/purchases/count?key=YOUR_PRIVATE_KEY' \

{
  "count": 783
}

Returns a paginated list of purchases.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

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

created_afterstring

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_beforestring

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

include_line_itemsboolean

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

affiliates_onlyboolean

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

Response

200

Object

Returns a paginated list of all purchases.

Response Attributes

idnumber

created_atstring

updated_atstring

cancelledboolean

currencystring

purchase_codestring

notestring

purchase_amountnumber

commission_amount_overridestring

cancellationstring

Show child attributes

leadobject

Show child attributes

affiliatestring

planobject

Show child attributes

line_itemsarray

Show child attributes

curl --location 'https://api.leaddyno.com/v1/purchases?key=YOUR_PRIVATE_KEY&page=1&created_after=2024-10-08&created_before=2024-10-10&include_line_items=true&affiliates_only=false' \

[
  {
    "id": 794,
    "created_at": "2024-10-09T19:30:00Z",
    "updated_at": "2024-10-09T19:30:00Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "04540cce-a364-4751-93a5-abcdefghijkl",
    "note": null,
    "purchase_amount": 100,
    "commission_amount_override": null,
    "cancellation": {
      "id": 30,
      "cancellation_code": "abc",
      "effective_date": "2024-10-09T19:58:18Z",
      "source": null
    },
    "lead": {
      "id": 1417,
      "email": "joe@foo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": [
      {
        "sku": "SKU-184",
        "description": "Monthly Subscription.",
        "quantity": "7.0",
        "amount": "80.97"
      },
      {
        "sku": "SKU-369",
        "description": "Add-Ons.",
        "quantity": "2.0",
        "amount": "9.52"
      }
    ]
  },
  {
    "id": 793,
    "created_at": "2024-10-09T19:28:58Z",
    "updated_at": "2024-10-09T19:28:58Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "21895df5-ca77-4768-82cc-abcdefghijkl",
    "note": null,
    "purchase_amount": 500,
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1418,
      "email": "joe@doo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": []
  },
  {
    "id": 792,
    "created_at": "2024-10-09T19:25:05Z",
    "updated_at": "2024-10-09T19:25:05Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "941ac75d-7d39-4b72-a7b8-abcdefghijkl",
    "note": null,
    "purchase_amount": null,
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1417,
      "email": "joe@foo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": []
  },
  {
    "id": 791,
    "created_at": "2024-10-09T19:24:52Z",
    "updated_at": "2024-10-09T19:24:52Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "7e62a6d7-4764-4a3a-833e-abcdefghijkl",
    "note": null,
    "purchase_amount": 700,
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1417,
      "email": "joe@foo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": []
  },
  {
    "id": 790,
    "created_at": "2024-10-09T19:21:34Z",
    "updated_at": "2024-10-09T19:58:20Z",
    "cancelled": true,
    "currency": "USD",
    "purchase_code": "b3017435-0eaf-4a65-bf8c-abcdefghijkl",
    "note": null,
    "purchase_amount": null,
    "commission_amount_override": null,
    "cancellation": {
      "id": 30,
      "cancellation_code": "abc",
      "effective_date": "2024-10-09T19:58:18Z",
      "source": null
    },
    "lead": {
      "id": 1417,
      "email": "joe@foo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": []
  },
  {
    "id": 789,
    "created_at": "2024-10-09T19:16:26Z",
    "updated_at": "2024-10-09T19:16:26Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "42b13f81-2b52-48ab-a9a0-1234567890",
    "note": null,
    "purchase_amount": null,
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1417,
      "email": "joe@foo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": []
  },
  {
    "id": 788,
    "created_at": "2024-10-09T18:47:44Z",
    "updated_at": "2024-10-09T18:47:44Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "cb3fad38-9e73-4434-81c3-1234567890",
    "note": null,
    "purchase_amount": 200,
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1417,
      "email": "joe@foo.com"
    },
    "affiliate": null,
    "plan": {
      "id": 1,
      "code": "Default"
    },
    "line_items": []
  }
]

This section allows users to cancel a specific purchase.

Query Parameters

keystring Required

Your private key

sourcestring

effective_datestring

cancellation_codestring

Response

200

Object

Cancels a purchase.

Response Attributes

idnumber

created_atstring

updated_atstring

cancelledboolean

currencystring

purchase_codestring

notestring

purchase_amountstring

commission_amount_overridestring

cancellationobject

Show child attributes

leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

curl --location --request DELETE 'https://api.leaddyno.com/v1/purchases/ID?key=YOUR_PRIVATE_KEY&source=api&effective_date=2024-07-01' \

{
  "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"
  }
}

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.

Query Parameters

keystring Required

Your private key

emailstring

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

purchase_codestring Required

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

sourcestring

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

effective_datestring (date-time)

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

cancellation_codestring

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

Response

200

Object

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.

Response Attributes

idnumber

created_atstring

updated_atstring

cancelledboolean

currencystring

purchase_codestring

notestring

purchase_amountstring

commission_amount_overridestring

cancellationobject

Show child attributes

leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

curl --location --request DELETE 'https://api.leaddyno.com/v1/purchases?key=YOUR_PRIVATE_KEY&email=joe%40foo.com&purchase_code=pi_abcdefghijkl&source=api&effective_date=2024-07-01' \

{
  "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"
  }
}

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

What made this section unhelpful for you?

Create a purchase

Header Parameters

Query Parameters

Body ParametersExpand all

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve a purchase by ID

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve a purchase by purchase code

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve purchase commissions

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve total purchase count

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

List all purchases

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Cancel a purchase by ID

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Cancel a purchase by purchase code or customer email

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Commissions

Leads

Visitors

Campaigns

Custom Fields

Sub IDs

Body Parameters

Response

Response

Response

Response

Response

Response

Response