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.

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.

Creates a new visitor entry in your LeadDyno account. You can manually create visitors using this endpoint and specify details like tracking code, email, and other relevant information.

Query Parameters

keystring Required

Your private key

Body Parameters

tracking_codestring Required

The tracking code assigned to the visitor. If not provided, a unique code will be generated automatically.

Response

201

Object

Creates a new visitor.

Response Attributes

idnumber

The unique identifier for the visitor.

created_atstring

The date and time the visitor was created.

updated_atstring

The date and time when the visitor information was last updated.

tracking_codestring

The tracking code assigned to the visitor. If not provided, a unique code will be generated automatically.

leadstring

Not specified.

urlstring

The URL of the current page the visitor is on.

referrerstring

The URL of the referring website that led the visitor to the current site.

search_termstring

The search term used by the visitor to reach the current site.

affiliatestring

The affiliate partner associated with the visitor.

campaignstring

The marketing campaign that brought the visitor to the site.

curl --location 'https://api.leaddyno.com/v1/visitors?key=YOUR_PRIVATE_KEY' \
--data '{
  "tracking_code": "b5fc67fa-72ea-4ec3-8635-abcdefghijkl"
}'

{
  "id": 8288,
  "created_at": "2024-09-25T19:38:46Z",
  "updated_at": "2024-09-25T19:38:46Z",
  "tracking_code": "b5fc67fa-72ea-4ec3-8635-abcdefghijkl",
  "lead": null,
  "url": null,
  "referrer": null,
  "search_term": null,
  "affiliate": null,
  "campaign": null
}

The endpoint (GET /visitors/:id) retrieves detailed information about a specific visitor based on their unique identifier. By requesting this endpoint, users can access valuable data about individual visitors for analysis and tracking purposes within the LeadDyno REST API.

Query Parameters

keystring Required

Your private key

Path Parameters

IDstring Required

The visitor ID

Response

200

Object

Returns the visitor with the given ID.

Response Attributes

idnumber

The unique identifier for the visitor.

created_atstring

The date and time the visitor was created.

updated_atstring

The date and time the visitor was last updated.

tracking_codestring

The tracking code linked to the visitor.

leadstring

Indicates whether the visitor is a lead.

urlobject

The URL linked to the visitor.

Show child attributes

referrerstring

The referrer URL for the visitor.

search_termstring

The search term used by the visitor.

affiliateobject

The affiliate associated with the visitor.

Show child attributes

campaignstring

The campaign identifier related to the visitor.

curl --location 'https://api.leaddyno.com/v1/visitors/8287?key=YOUR_PRIVATE_KEY' \

{
  "id": 8287,
  "created_at": "2024-09-06T17:07:53Z",
  "updated_at": "2024-09-06T17:07:53Z",
  "tracking_code": "b5fc67fa-72ea-4ec3-8635-abcdefghijkl",
  "lead": null,
  "url": {
    "id": 50,
    "url": "https://example.com/product/ecosaver-pro?afmc=1w"
  },
  "referrer": null,
  "search_term": null,
  "affiliate": {
    "id": 17167,
    "email": "ld-preview-affiliate@leaddyno.com"
  },
  "campaign": null
}

The endpoint (GET /visitors/by_tracking_code) retrieves detailed information about a visitor by specifying their unique tracking code. By using this API section, users can access visitor data associated with a specific tracking code, enabling them to analyze visitor behavior and interactions on their platform.

Query Parameters

keystring Required

Your private key

tracking_codestring Required

The unique tracking code assigned to the visitor to retrieve their information.

Response

200

Object

Returns the visitor with the given tracking code.

Response Attributes

idnumber

created_atstring

updated_atstring

tracking_codestring

leadstring

urlobject

Show child attributes

referrerstring

search_termstring

affiliateobject

Show child attributes

campaignstring

curl --location 'https://api.leaddyno.com/v1/visitors/by_tracking_code?key=YOUR_PRIVATE_KEY&tracking_code=%3Ctracking_code%3E' \

{
  "id": 8287,
  "created_at": "2024-09-06T17:07:53Z",
  "updated_at": "2024-09-06T17:07:53Z",
  "tracking_code": "b5fc67fa-72ea-4ec3-8635-abcdefghijkl",
  "lead": null,
  "url": {
    "id": 50,
    "url": "https://example.com/product/ecosaver-pro?afmc=1w"
  },
  "referrer": null,
  "search_term": null,
  "affiliate": {
    "id": 17167,
    "email": "ld-preview-affiliate@leaddyno.com"
  },
  "campaign": null
}

This endpoint (GET /visitors/count) allows users to retrieve the total number of visitors tracked by LeadDyno.

Query Parameters

keystring Required

Your private key

Response

200

Object

Returns the total number of visitors.

Response Attributes

countnumber

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

{
  "count": 8192
}

Returns a paginated list of visitors. Visitors are returned in descending order by creation date, with the most recent visitors appearing first. Use the page parameter to navigate through the results. Each page contains up to 100 records.

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 a paginated list of visitors, 100 per page.

Response Attributes

idnumber

created_atstring

updated_atstring

tracking_codestring

leadstring

Show child attributes

urlstring

Show child attributes

referrerstring

search_termstring

affiliatestring

Show child attributes

campaignstring

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

[
  {
    "id": 8288,
    "created_at": "2024-09-25T19:38:46Z",
    "updated_at": "2024-09-25T19:38:46Z",
    "tracking_code": "00035dc5-c2fa-4099-bc7b-abcdefghijkl",
    "lead": {
      "id": 1695,
      "email": "lead@example.com"
    },
    "url": {
      "id": 50,
      "url": "https://example.com/product/ecosaver-pro?afmc=1w"
    },
    "referrer": null,
    "search_term": null,
    "affiliate": {
      "id": 17167,
      "email": "ld-preview-affiliate@leaddyno.com"
    },
    "campaign": null
  },
  {
    "id": 8287,
    "created_at": "2024-09-06T17:07:53Z",
    "updated_at": "2024-09-06T17:07:53Z",
    "tracking_code": "b5fc67fa-72ea-4ec3-8635-abcdefghijkl",
    "lead": null,
    "url": {
      "id": 50,
      "url": "https://example.com/product/ecosaver-pro?afmc=1w"
    },
    "referrer": null,
    "search_term": null,
    "affiliate": {
      "id": 17167,
      "email": "ld-preview-affiliate@leaddyno.com"
    },
    "campaign": null
  },
  {
    "id": 8286,
    "created_at": "2024-09-06T17:07:52Z",
    "updated_at": "2024-09-06T17:10:31Z",
    "tracking_code": "f5edb52e-a7ee-43f3-9054-abcdefghijkl",
    "lead": {
      "id": 1695,
      "email": "lead@example.com"
    },
    "url": {
      "id": 50,
      "url": "https://example.com/product/ecosaver-pro?afmc=1w"
    },
    "referrer": null,
    "search_term": null,
    "affiliate": {
      "id": 17167,
      "email": "ld-preview-affiliate@leaddyno.com"
    },
    "campaign": null
  }
]

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

Leads

Visitors

What made this section unhelpful for you?

Create a visitor

Query Parameters

Body Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve a visitor by ID

Query Parameters

Path Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve a visitor by tracking code

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve total visitor count

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

List all visitors

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Campaigns

Custom Fields

Sub IDs

Response

Response

Response