API Docs

stars with dark background.

Ignite Platform

The Ignite platform API allows you to retrieve information about audiences, locations, visitors, and products for a given platform website and look-back date.

API Base URL

Unless otherwise noted:

GET https://e.atrc.link/api

Entities

Website

A website with the platform tracking library installed and an active subscription

Location

A verified residential location that visits a website and can be resolved to an address

Visitor

An identified visitor to a website based on their association with a location

Products

Inventory data about products & items available for sale on websites

Audience

A group of visitors with an interest in a product or service on a website

Audience Group

A group of audiences for a website

Opt Outs

Bulk add email addresses that have opted out of communications

Sales

Sales data summary for website

Authentication

All requests must include a valid token and secret for a given platform website. Credentials are available in the platform Website Info section.

Look-back Date

Where appropriate, the API will allow you to restrict responses to a given look-back window.

Unless otherwise noted, the look-back date is the start of the date window where an entity was last seen on the website. The default look-back window is 30 days. Or, put another way, by default the API will return entities seen on the website within the last 30 days.

You may over-ride the default look-back window by passing the date parameter in the format YYYY-MM-DD

Example:  date=2020-01-20

The max look-back window is 60 days. Requests over 60 days will be defaulted to 30 days.

Hashing Algorithms

Some requests will return hashed email identifiers for entities.

By default, these are MD5 hashes. The API will also return other formats by including the algo parameter in your request.

Example: algo=sha1

Current supported algorithms are: md5 sha1 sha2 . If you require additional formats, please let your account representative know.

Visitors

A collection of hashed email identifiers for all identified visitors from the last 30 days

End point

GET /visitors

Required Parameters

tokensecret

Optional Parameters

date

algo

Example Request

https://e.atrc.link/api/visitors?token=abc123&secret=def456

Example Response

{{codeblock_1}}

Products

A collection of data for active products listed on websites

End point

GET /products

Required Parameters

tokensecret

Optional Parameters

date

algo

Example Request

https://e.atrc.link/api/products?token=abc123&secret=def456

Example Response

{{codeblock_2}}

Locations

End pointGET /locations

Required Parameters

tokensecret

Optional Parameters

date

Example Request

https://e.atrc.link/api/locations?token=abc123&secret=def456

Example Response

{{codeblock_3}}

Location Details

End pointGET /locations/ID where ID is a valid id for a website location

Required Parameters

tokensecret

Optional Parameters

algo

Example Request

https://e.atrc.link/api/locations/123?token=abc123&secret=def456

Example Response

{{codeblock_4}}

Audiences

End pointGET /audiences

Required Parameters

tokensecret

Example Request

https://e.atrc.link/api/audiences?token=abc123&secret=def456

Example Response

{{codeblock_5}}

Audience Details

Hashed email identifiers for a given audience ID, for the look-back window.

Note: The number of identifiers may differ from the visitors_count in the /audiences end point as email resolution is not possible for all visitors and in some cases visitors may resolve multiple emails.

End pointGET /audiences/ID where ID is a valid audience ID for the website

Required Parameters

tokensecret

Optional Parameters

datealgo

Example Request

https://e.atrc.link/api/audiences/ID?token=abc123&secret=def456

Example Response

{{codeblock_6}}

Audience Groups

Audience Groups can be defined by creating new custom audiences under the settings tab in the Web UI.

End pointGET /audience_groups

Required Parameters

tokensecret

Example Request

https://e.atrc.link/api/audience_groups?token=abc123&secret=def456

Example Response

{{codeblock_7}}

Audience Group Details

Hashed email identifiers for a given audience group ID, for the look-back window.

Note: The number of identifiers may differ from the visitors_count in the /audience_groups end point as email resolution is not possible for all visitors and in some cases visitors may resolve multiple emails.

End pointGET /audience_groups/ID where ID is a valid audience ID for the website

Required Parameters

tokensecret

Optional Parameters

datealgo

Example Request

https://e.atrc.link/api/audiences/ID?token=abc123&secret=def456

Example Response

{{codeblock_8}}

Opt Outs

If you have a one or many email addresses that have already unsubscribed from communications, you can bulk suppress them in the platform

Note that authentication secret is not required, so you could integrate this into a web form and pass client side requests to it for unsubscribes.

Required Parameters

token emails

The emails parameter can either be a single email address or a JSON encoded array of multiple email addresses

Example Request

POST https://e.atrc.link/opt_outs/new?token=abc123&emails=test@domain.com

Example Response

{{codeblock_9}}

Sales

Summary of sales data, including match back and attribution, are available for all uploaded sales records

Required Parameters

token

Example Request

GET https://e.atrc.link/api/sales?token=abc123&secret=def456

Example Response

{{codeblock_10}}

[
"d1540b59802754a41d5005aafa08722",
"043c97d5a9826121285fed5339ed132",
"71d73b96312c9d435f1a4d6db2c7c57",
"3d0af46c815775ab955946cdc34542d",
"6221ea7375ed0516840d4edac1fb147",
...
]
[
{
"url": "<https://www.website.com/inventory/new-2022-honda-hr-v-lx-fwd-sport-utility-3czru5h3xnm705748/>",
"title": "New 2022 Honda HR-V LX Sport Utility #NM705748",
"item_condition": "NEW",
"color": "PLATINUM",
"created_at": "2021-10-03T17:14:07.480Z",
"updated_at": "2021-10-04T13:36:32.331Z",
"year": "2022",
"make": "Honda",
"model": "HR-V",
"trim": "LX",
"stock": "NM705748",
"vin": "3CZRU5H3XNM705748",
"feature_image_url": "<https://image-host/imageurl.png>"
}
]
[
{
"id": 59378,
"latitude": 35.783336,
"longitude": -78.848969,
"street": "406 Daylin Dr",
"city": "Cary",
"state": "nc",
"zip": "27519",
"resident": "JON SNOW"
}
]
{
"id": 59378,
"latitude": 35.783336,
"longitude": -78.848969,
"street": "406 Daylin Dr",
"city": "Cary",
"state": "nc",
"zip": "27519",
"resident": "JON SNOW",
"hashed_emails": [
"1ca81507aa511c9501c24cdea61e06",
"4f19af40f5ba74309b1dc0e594aa8d"
],

"summary": {
"visit_last": "2021-04-29T14:41:32.000Z",
"visit_first": "2021-03-08T19:42:52.000Z",
"session_count": 7,
"traffic_score": 108,
"page_view_count": 23,
"top_topic_segments": "NEW",
"top_product_segment": "NEW HONDA ACCORD SEDAN",
"traffic_score_stars": 4.5
},

"pages": [...] // list of pages visited
}
[
{
"id": 4922,
"primary_category": "USED",
"brand": "MERCEDES-BENZ",
"model": "C-CLASS",
"visitors_count": 123
},

{
"id": 18687,
"primary_category": "USED",
"brand": "KIA",
"model": "RIO5",
"visitors_count": 2
}

]
[
"28d8dfd2afe8c09ab1f99920e4026b8",
"4f8d58443835f3e0ac4d7eee3c58647",
"47433718fd101c960807c2b2e6a10f4"
]
[
{
"id": 15,
"label": "Used Model Visitors",

"primary_categories": [
"USED"
],
"brands": [],
"models": [],
"visitors_count": 106931
}
]
[
"28d8dfd2afe8c09ab1f99920e4026b8",
"4f8d58443835f3e0ac4d7eee3c58647",
"47433718fd101c960807c2b2e6a10f4"
]


{}




{
"sales" : [],
"matched_sales": []
}