This endpoint will give you an access token that you will use to generate an api key.
\n","urlObject":{"protocol":"https","path":["api","get_token",""],"host":["idl5","layerfive","com"],"query":[],"variable":[]}},"response":[{"id":"d15ec251-c615-478a-83af-2989ef89f723","name":"Request Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"layerfiverest@layerfive.com","type":"text"},{"key":"password","value":"Layerfive2021!","type":"text"}]},"url":"https://idl5.layerfive.com/api/get_token/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 18 Nov 2021 08:35:19 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.9.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"3246"}],"cookie":[],"responseTime":null,"body":"{\n \"access\": \"dHJ1ZSwiZXhwb3J0IjpmYWxzZX0sIkZhY2Vib29rQWRzIjp7InZpZXciOnRydWUsImV4cG9ydCI6ZmFsc2V9LCJHb29nbGVUcmVuZCI6eyJ2aWV3Ijp0cnVlLCJleHBvcnQiOmZhbHNlfSwiT3JkZXJDcmVkaXQiOnsidmlldyI6dHJ1ZSwiZXhwb3J0IjpmYWxzZX0sIkNoYW5uZWxCbG9jayI6eyJ2aWV3Ijp0cnVlLCJleHBvcnQiOmZhbHNlfSwiR29vZ2xlVmlzaXRzIjp7InZpZXciOnRydWUsImV4cG9ydCI6ZmFsc2V9LCJGYWNlYm9va1RyZW5kIjp7InZpZXciOnRydWUsImV4cG9ydCI6ZmFsc2V9LCJGYWNlYm9va1Zpc2l0cyI6eyJ2aWV3Ijp0cnVlLCJleHBvcnQiOmZhbHNlfSwiTGF5ZXJmaXZlVHJlbmQiOnsidmlldyI6dHJ1ZSwiZXhwb3J0IjpmYWxzZX0sIk9yZGVyQ292ZXJhZ2VCbG9jayI6eyJ2aWV3Ijp0cnVlLCJleHBvcnQiOmZhbHNlfSwiT3JkZXJCeVNvdXJjZXNCbG9jayI6eyJ2aWV3Ijp0cnVlLCJleHBvcnQiOmZhbHNlfSwiT3JkZXJEYXlzVG9Db252QmxvY2siOnsidmlldyI6dHJ1ZSwiZXhwb3J0IjpmYWxzZX19LCJjcmVhdGUiOmZhbHNlLCJkZWxldGUiOmZhbHNlLCJleHBvcnQiOmZhbHNlLCJtb2R1bGUiOnRydWV9fSwiZmlyc3RfdGltZV9sb2dpbiI6ZmFsc2V9fQ.H3yK_fnF_QO1z31p6708c9akz5udLe6yOvO_4s0idUQ\",\n \"is_agency\": false\n}"}],"_postman_id":"1751467b-65ed-4d48-8a17-7e78824323e9"},{"name":"Request Api Key","id":"fef74963-185b-4d5b-93c8-fe7694d35296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint will give you an api key. You need to pass that api key in an l5key header to all of our api endpoints.
\n","urlObject":{"protocol":"https","path":["api","v1","oauth","api_key"],"host":["idl5","layerfive","com"],"query":[],"variable":[]}},"response":[{"id":"238e3811-d0b4-437c-a6ef-8dc15d3ef184","name":"Request api key","originalRequest":{"method":"GET","header":[],"url":"https://idl5.layerfive.com/api/v1/oauth/api_key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 18 Nov 2021 09:54:01 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.9.7"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"122"}],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": 200,\n \"responseData\": \"MzcxKzEwMadsdvj4jKJd\"\n}"}],"_postman_id":"fef74963-185b-4d5b-93c8-fe7694d35296"},{"name":"Get ID graph","id":"d73814f5-b006-4a86-8b31-ca7efb522c95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"l5key","value":"This API endpoint provides the customer id graph that includes the source from which a customer originated, along with their first and last seen dates. The child_id here refers to the customer's email. By providing the customers' email, you can track their engagement over time.
\n","urlObject":{"protocol":"https","path":["api","v1","get_id_graph"],"host":["idl5","layerfive","com"],"query":[{"key":"child_id","value":"This API endpoint empowers you to seamlessly fetch visit data based on a designated date range and delve into specific details that pique your interest. Uncover valuable insights, like the visitor's source (media source), pivotal order details such as the unique order identifier (order ID) and the total revenue generated by a specific order, journey trajectory, geographical location, and devices utilized, etc. The beauty lies in its adaptability, allowing you to tailor the information retrieval process to meet your precise analytical needs.
\nYou can create a unique visit identifier by amalgamating ‘l5_person_id’, ‘session_id’, ‘event_date’ and ‘event_type’, providing you with a comprehensive gateway to access detailed visit information. The key to precision lies in harnessing the ‘updated_at’ date filter, enabling you to effortlessly retrieve visit details within a specified timeframe. Whether you're interested in events occurring after or before a particular 'updated_at' date, this endpoint empowers you to curate the most pertinent visit data for your in-depth analysis.
\nProvide either updated_at or start_date & end_date.
\nLimit param can be upto 500. By default it is 250.
\n","urlObject":{"protocol":"https","path":["api","v1","eventsessions"],"host":["idl5","layerfive","com"],"query":[{"key":"start_date","value":"YYYY-MM-DD"},{"key":"end_date","value":"YYYY-MM-DD"},{"key":"updated_at","value":"YYYY-MM-DDTHH:MM:SS"},{"key":"page","value":"1"},{"key":"limit","value":"250"}],"variable":[]}},"response":[{"id":"826d2b9f-06a2-4ad7-baaf-ba3253715a69","name":"Get Event Sessions","originalRequest":{"method":"GET","header":[{"key":"l5key","value":"Mzc0KzE4MytwYXdhbi5rdW1hckBsYXllcmZpdmUuY29tK","type":"text"}],"url":{"raw":"https://idl5.layerfive.com/api/v1/eventsessions?start_date=2024-01-01&end_date=2024-01-03&page=1&limit=100","protocol":"https","host":["idl5","layerfive","com"],"path":["api","v1","eventsessions"],"query":[{"key":"start_date","value":"2024-01-01"},{"key":"end_date","value":"2024-01-03"},{"key":"page","value":"1"},{"key":"limit","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 25 Jan 2024 09:42:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"36243"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"data\": [\n {\n \"l5_person_id\": \"55d-4a24-8f4a-b02cf14fb51d\",\n \"session_id\": \"ad6be-4867-9b6e-9b346359a24f\",\n \"event_date\": \"2024-01-01T08:02:16.844000\",\n \"event_type\": \"page_view\",\n \"utm_campaign\": \"blog\",\n \"utm_content\": \"website\",\n \"media_source\": \"amplify\",\n \"country\": \"NL\",\n \"device_type\": \"Mobile\",\n \"order_id\": null,\n \"page\": \"/collection/product_1\",\n \"company_name\": null,\n \"company_domain\": null,\n \"company_type\": null\n },\n {\n \"l5_person_id\": \"73-4d37-acc2-926cc2b464d7\",\n \"session_id\": \"sdsd-4796-afd2-f5ed93904d81\",\n \"event_date\": \"2024-01-01T08:02:20.085000\",\n \"event_type\": \"page_view\",\n \"utm_campaign\": null,\n \"utm_content\": null,\n \"media_source\": \"Direct\",\n \"country\": \"US\",\n \"device_type\": \"Unknown\",\n \"order_id\": null,\n \"page\": \"/collection/category/product_1\",\n \"company_name\": null,\n \"company_domain\": null,\n \"company_type\": null\n }\n ]\n}"}],"_postman_id":"541d4f35-0971-49aa-ab07-bca092bd5f6b"},{"name":"Get Conversion Details","id":"6b0df8c3-5d99-4b4b-9359-bec401553262","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"l5key","value":"This endpoint will give you the conversion details within the give date range. Provide updated_at if you need data after a single date.
\nstart_date ('YYY-MM-DD')
\nend_date ('YYY-MM-DD')
\nsince_date ('YYY-MM-DDTHH:MM:SS')
\npage
\nlimit
\nThis endpoint will give you a customer 360 view in terms of his/her following below details
\nThis endpoint will give you a customer 360 view that will include the following details
\nThis endpoint returns the customer journey details of all known individuals since the provided event_date or the last 90 days of the journey for an email provided. If the event_date parameter is provided, the API will return the customer journey details of all known individuals since the provided event_date, as well as the last 90 days' journey details for individuals who became known since the event_date. In the absence of both parameters, this API will return the customer journey data of the last 24 hours.
\nIn other words, the API returns customer journey details for two different groups of individuals, depending on the parameters provided:
\nIf an email address is provided, the API returns the last 90 days' journey details for that email address.
If an event_date parameter is provided, the API returns the customer journey details for all known individuals since the provided event_date, as well as the last 90 days' journey details for individuals who became known since the event_date.
If neither parameter is provided, the API returns the last 24 hours of customer journey data for all known individuals.
Here's an example of how this API endpoint could be used:
\nLet's say there is a marketing campaign running from July 1, 2022 to August 31, 2022. We can use the API endpoint and specify the event_date parameter as \"2022-07-01\" and the API will return the journey details for all individuals who became known on or after July 1, 2022 (includes all individuals who have become known to the system since that date, regardless of whether they were already known prior to that date or not), as well as the last 90 days' journey details for those individuals who became known since July 1, 2022 (these individuals may have started their journey before this date, but they were not known to the system until after this date). This will allow us to see the journey details for all individuals who were potentially influenced by the marketing campaign during the specified time period.
\nAlternatively, let's say we want to retrieve journey details for a specific email address, \"example@email.com\". We can use the API endpoint and specify the email address parameter as \"example@email.com\" and the API will return the journey details for that email address for the last 90 days. This will allow us to see the journey details for a specific individual and understand their engagement with the brand over the last 90 days.
\nFinally, if we don't specify any parameter, the API will return the journey details for all known individuals for the last 24 hours. This could be useful if we want to get a quick overview of recent customer engagement with the brand.
\nThis API allows users to fetch the email addresses of all known identities who became known between a specified date range. The API endpoint accepts the start date and end date parameters and returns a list of email addresses for the known identities within that date range.
The start_date is a required parameter while end_date is an optional parameter.
In the absence of the end_date, the API will return a list of email addresses for the known identities from the start_date provided by the user, till the current date.
The accepted format for start_date or end_date is YYYY-MM-DD.
\n","urlObject":{"protocol":"https","path":["api","v1","known_identity_details"],"host":["idl5","layerfive","com"],"query":[{"key":"start_date","value":"2023-03-21"},{"key":"end_date","value":"2023-03-27"},{"key":"page","value":"1"},{"key":"limit","value":"250"}],"variable":[]}},"response":[{"id":"25360a6c-e772-43e7-becf-f7acceaf44c9","name":"GET Known Identity Details","originalRequest":{"method":"GET","header":[{"key":"l5key","value":"MzY2KzEwMStzdXNoaWxAbGF5ZXJmaXZlLmNvbStUcnVl:U9VOGwVzmbFPs8JU06oQcm0JBrM","type":"text"}],"url":{"raw":"https://idl5.layerfive.com/api/v1/known_identity_details?start_date=2023-03-21&end_date=2023-03-27","protocol":"https","host":["idl5","layerfive","com"],"path":["api","v1","known_identity_details"],"query":[{"key":"start_date","value":"2023-03-21"},{"key":"end_date","value":"2023-03-27"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 17 Aug 2023 08:21:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"135480"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 600,\n \"data\": [\n {\n \"l5_person_id\": \"8ac19bfd-2d28-748a57359204\",\n \"email\": \"willyw@yahoo.com\",\n \"known_since\": \"2023-03-23T01:32:02\"\n },\n {\n \"l5_person_id\": \"a64689c4-42-4ad1-8917c85ddb00\",\n \"email\": \"stcnett@gmail.com\",\n \"known_since\": \"2023-03-22T15:48:30\"\n },\n {\n \"l5_person_id\": \"e87b0b33-sdsd-a5ee-0f5e29146b2f\",\n \"email\": \"mer@gmail.com\",\n \"known_since\": \"2023-03-23T02:28:20\"\n }\n ]\n}"}],"_postman_id":"5c9d762f-3067-4633-a7cc-a28149c48b91"},{"name":"Get Media Attribution","id":"523001ef-43f8-421c-af2b-63f0fdc36171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"l5key","value":"This endpoint will give you the performance by media within the give date range like the number of orders and total revenue by a source.
\nThis endpoint will give you the performance by ad within the give date range like the number of orders and total revenue by a source.
\n