Lytics Profile Schema

Last updated November 5, 2026

Lytics profiles enjoy access to both a universal schema, which provides computed, intelligent attributes on every profile in Lytics, as well as a common schema, a set of standard attributes that facilitates faster integration and more reliable consistency when integrating profiles to and from other systems.

Growth and Enterprise Lytics accounts may also customize their schema with additional fields and mappings.

Universal Schema

Lytics' universal schema delivers a set of intelligent attributes that are universal to every profile that gets created, regardless of data source, age, or their anonymous or known status.

These attributes include rich behavioral models, AI-derived interests, and identity resolution metadata, leading to more comprehensive insights on all of your profiles. (Not just the known ones!)

Universal attributes provide a common vocabulary with which to think about how you might engage with each and every individual — what they're interested in, what their engagement has been, or how they're likely to engage in the future.

Identifiers

Identifiers in Lytics Schema serve to stitch profiles together. For instance, if you pass an email along with the _uid, all events that have only been associated with either identifier will be merged into a single comprehensive profile.

Default identifiers are listed below. Some jobs in your data pipeline may add new identifiers to your schema, like shopify_customer_id or salesforce_contact_ids.

Field	Short Description	Long Description	Example
_id	Lytics ID	A unique ID that represents the materialized profile in Lytics.	"4fafb5b3-b199-58f2-a68b-4b266b363dd1"

Metafields

Metafields encompass all system-level information that provides insights into the health and breadth of the profile. This includes data such as creation date, last update timestamp, source information, and other metadata associated with the profile's management and maintenance. Metafields offer a behind-the-scenes view of the profile's overall status and administration.

Field	Short Description	Long Description	Example
_created	Created	The time a profile was created.	"2024-02-28T02:45:51.377423153Z"
_last_scored	Last Scored Timestamp	The time a profile was last scored by Lytics.	"2024-02-28T02:45:51.377423153Z"
_modified	Modified Timestamp	The time a profile was last modified by Lytics.	"2024-02-28T02:45:51.377423153Z"
_num_aliases	Number of Aliases	The number of aliases for a profile, as calculated by Lytics' Identity Resolution.	5
_num_days	Number of Days	The number of distinct days a profile has had activity.	3
_num_events	Number of Events	The total number of events processed for a profile.	81
_num_streams	Number of Streams	The number of distinct data streams in which a profile has been present.	2
_streamnames	Stream Names	The distinct streams in which a profile has been present.	["default"]

Behavioral

Behavioral attributes comprise a multidimensional set of scores that provide insight into an individual's behavior over time.

These insights are invaluable when personalizing experiences based on changes in behavior or behaviors indicative of high likelihood. For instance, you might want to present a premium offer to users exhibiting higher momentum than usual.

Behavioral attributes enable targeted and timely interventions tailored to user actions and patterns.

Field	Short Description	Long Description	Example
score_consistency	Consistency	Measures the long-term consistency of a typical user's daily engagement.	56
score_frequency	Frequency	Measures the frequency of a user's engagement, relative to your most frequent users.	74
score_intensity	Intensity	Measures the depth of a typical user's daily engagement.	3
score_maturity	Maturity	Measures the length of a user's history, relative to your most mature users.	97
score_momentum	Momentum	Measures the rate at which user engagement is changing.	45
score_propensity	Propensity	Measures how likely a user is to re-engage with more activity.	91
score_quantity	Quantity	Measures the quantity of a user's engagement, relative to your most frequent users.	12
score_recency	Recency	Measures the recency (over a 1 year window) of a user's engagement.	28
score_volatility	Volatility	Measures the long-term volatility of the depth of a typical user's daily engagement.	63

Interests

Interests entail understanding the topics a user is interested in based on their interactions, cross-referenced by deep programmatic analysis of their online activities. This allows for tailored content recommendations and targeted messaging aligned with the user's preferences and engagement history.

Field	Short Description	Long Description	Example
lytics_content	Lytics Content	A map of topic-level interests for the user.	{"Shoes":0.76,"Pants":0.43}

Intelligence

Attributes classified as intelligence encompass diverse, highly valuable information to facilitate relevant and high-value personalized experiences. Within this category, you'll discover real-time segment membership, values crucial for split testing and experimentation, and direct correlation to our real-time machine learning modeling. These attributes empower dynamic and data-driven decision-making, enhancing the efficacy of personalized marketing strategies.

Field	Short Description	Long Description	Example
_segments	Segment Membership	The segments or audiences of which on individual is a member.	["all", "anonymous_profiles", "smt_power"]
_split	Random Split 1	A randomly assigned value for making randomized audiences and driving experiments.	0
_split2	Random Split 2	A randomly assigned value for making randomized audiences and driving experiments.	99
segment_prediction	Lytics Predictive Scores	Scores from Lytics SegmentML Predictive Models.	{"likely_to_buy_shoes": 0.47}
segment_prediction_percentile	Lytics Preditive Percentiles	Percentiles from Lytics SegmentML Predictive Models.	{"likely_to_buy_shoes": 91}

_split

Random splits are assigned by algorithmic hashing and result in an even distribution across profiles.

There are 100 possible splits (0-99), so creating an audience where _split = 44 would result in a random subset of 1% of profiles. A random split where _split < 50 would result in a subset of 50% of profiles.

_split2

Having access to two random split assignments allows you to target 100*100, or 10k different subsets of your audiences.

This means you can create splits that are capable of targeting down to 0.01% of profiles.

segment_prediction

Lytics' SegmentML models provide scores for modeling custom outcomes in Lookalike models. Each active model attaches a score (between 0 and 1) to a profile with its name.

segment_prediction_percentile

Similar to segment_prediction values, the percentiles provide the ability to create audiences and target users based on their percentile instead of their raw score. This enables you, for example, to create audiences of users with the top 10% of scores (by using segment_prediction_percentile > 90).

Common Schema

Common fields help to structure your profiles in a way for developers to easily plug into them, and for marketers to easily use them in personalization.

Common mappings help to translate your source data into a format that can be used by common fields.

These fields and mappings help to provide consistency in your profiles, regardless of the source from which the data came.

For example, your CRM might have "tax_exempt": "true", while your data warehouse might has "tax_status": "exempt", and your ESP might have "is_tax_exempt": 1. In Lytics' Common Schema, this would simply be represented as "tax_exempt": true.

Pre-defined Mappings

For your convenience, jobs managed in your Data Pipeline will automatically create schema fields and mappings to implement Lytics Common Schema in your data so that you can get to more use cases more quickly.

Some fields, like name, are automatically part of every Lytics account.

Other channel-specific fields will be added when you add channel-specific data sources to your account. For example, adding a Shopify import job to your data sources would add the common schema field purchase_total, among others.

Identifiers

Default identifiers are listed below. Some jobs in your data pipeline may add new identifiers to your schema, like shopify_customer_id or salesforce_contact_ids.

Field	Short Description	Long Description	Example
_uids	Web Cookie Id: All	All cookies associated with a profile.	["50b772f5-a0be-42f2-8828-84b8db5d5a23"]
email	Email Address	Email address of a profile.	"[email protected]"
email_sha256	Email Address: Hash (SHA256)	SHA256 hash of the profile's email address.	"e43763399e5318f14cd7473c4902a6b319343d577ec8283898a5edf9dbc6d711"
external_id	External ID	An identifier to link a profile to custom sources.	"abc123"

_uids

JavaScript

jstag.send({
  "_uid": "50b772f5-a0be-42f2-8828-84b8db5d5a23"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "_uid": "50b772f5-a0be-42f2-8828-84b8db5d5a23"
}'

HTTPie

echo '{
  "_uid": "50b772f5-a0be-42f2-8828-84b8db5d5a23"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "_uid": "50b772f5-a0be-42f2-8828-84b8db5d5a23"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

email

An individual's email address is automatically standardized (syntactically validated and lower-cased) so as to be compatible as an identifier in your identity graph.

JavaScript

jstag.send({
  "email_address": "[email protected]"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "email_address": "[email protected]"
}'

HTTPie

echo '{
  "email_address": "[email protected]"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "email_address": "[email protected]"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

email_sha256

The SHA256 hash of an individual's email address. In the event that your account has an email address present, the hash is automatically computed so as to be compatible with external systems that require the SHA256 hash for integration. In the event that you don't want any PII in your account, you can pass the hash directly instead of the raw address.

JavaScript

jstag.send({
  "email_address": "[email protected]"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "email_address": "[email protected]"
}'

HTTPie

echo '{
  "email_address": "[email protected]"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "email_address": "[email protected]"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

external_id

Optional, and if provided, this will usually come from your proprietary, first-party database. This will be used for profile stitching and should therefore be unique to an individual.

JavaScript

jstag.send({
  "external_id": "abc123"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "external_id": "abc123"
}'

HTTPie

echo '{
  "external_id": "abc123"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "external_id": "abc123"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Interests

Field	Short Description	Long Description	Example
hashedurls	Hashed URLs	A map of URLs an individual has engaged with, indexed by each URL's hashed value.	{"hashedurls":{"4058474390481920149":5,"680176754148162020":2}}

hashedurls

A history of an individual's most recently visited URLs, helpful for powering Lytics' Context Layers. A siphash of each URL's sanitized value (without query parameters) is used to index the map.

hashedurls are used in Lytics' standard Context Layer, but you can create additional Context Layers with other sets of URLs, product IDs, or atomic content IDs from your CMS.

JavaScript

jstag.send({
  "url": "www.lytics.com/blog/real-talk-about-real-time-cdps/"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "url": "www.lytics.com/blog/real-talk-about-real-time-cdps/"
}'

HTTPie

echo '{
  "url": "www.lytics.com/blog/real-talk-about-real-time-cdps/"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "url": "www.lytics.com/blog/real-talk-about-real-time-cdps/"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Intelligence

Field	Short Description	Long Description	Example
next_event	Next Event	Stream-specific preditions for the timestamp of the next expected interaction on a stream.	``
needs_message	Needs Message	Stream-specific score to predict how much an individual "needs" a message on a data stream.	``

needs_message

The "needs message" score evaluates how likely an individual is to engage on a channel without any messaging.

A higher score would indicate that an individual is less likely to return within a typical engagement window (relative to other individuals in a data stream). A lower score would indicate that they are more likely to return within a typical engagement window.

Details

Details encompass all default attributes related to user demographics and general information, including name, phone number, status, etc. It serves as a catch-all for attributes not specifically tied to interactions or behaviors.

Field	Short Description	Long Description	Example
first_name	First Name	An individual's first name.	"Jane"
last_name	Last Name	An individual's last name.	"Doe"
name	Name	An individual's name.	"Jane Doe"
birthday	Birthday	An individual's birthday.	"July 22"
birthday	Date of Birth	An individual's exact date of birth.	"2000-07-22"
phone	Phone Number	In most cases, this will be automatically formatted in E.164 format.	"+15555555555"
phone_mobile	Mobile Phone Number	In most cases, this will be automatically formatted in E.164 format.	"+15555555555"
address1	Address 1	First line of customer address.	"30 Rockefeller Plaza"
address2	Address 2	Second line of customer address.	"Suite 1000"
city	City	This will usually correspond to a contact-provided value -- registration, shipping address, etc.	"New York"
region	Region, State or Province	This will usually correspond to a contact-provided value -- registration, shipping address, etc.	"NY"
country	Country	This will usually correspond to a contact-provided value -- registration, shipping address, etc.	"USA"
postal_code	Postal Code	This will usually correspond to a contact-provided value -- registration, shipping address, etc.	"10112"
status	Profile Status	This may be used to indicate a generic customer status -- active, churned, premium, unknown, etc.	"active"

first_name

JavaScript

jstag.send({
  "first_name": "Jane"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "first_name": "Jane"
}'

HTTPie

echo '{
  "first_name": "Jane"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "first_name": "Jane"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

last_name

JavaScript

jstag.send({
  "last_name": "Doe"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "last_name": "Doe"
}'

HTTPie

echo '{
  "last_name": "Doe"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "last_name": "Doe"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

name

An individual's name may take a few forms, depending on the source, and this field may sometimes be just the first name, a combination of names, or completely empty.

JavaScript

jstag.send({
  "name": "Jane Doe"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "name": "Jane Doe"
}'

HTTPie

echo '{
  "name": "Jane Doe"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "name": "Jane Doe"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

birthday

JavaScript

jstag.send({
  "birthday": "July 22"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "birthday": "July 22"
}'

HTTPie

echo '{
  "birthday": "July 22"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "birthday": "July 22"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

birthday

JavaScript

jstag.send({
  "dob": "2000-07-22"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "dob": "2000-07-22"
}'

HTTPie

echo '{
  "dob": "2000-07-22"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "dob": "2000-07-22"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

phone

JavaScript

jstag.send({
  "phone": "555-555-5555"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "phone": "555-555-5555"
}'

HTTPie

echo '{
  "phone": "555-555-5555"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "phone": "555-555-5555"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

phone_mobile

JavaScript

jstag.send({
  "mobile": "555-555-5555"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "mobile": "555-555-5555"
}'

HTTPie

echo '{
  "mobile": "555-555-5555"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "mobile": "555-555-5555"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

address1

JavaScript

jstag.send({
  "address1": "30 Rockefeller Plaza"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "address1": "30 Rockefeller Plaza"
}'

HTTPie

echo '{
  "address1": "30 Rockefeller Plaza"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "address1": "30 Rockefeller Plaza"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

address2

JavaScript

jstag.send({
  "address2": "Suite 1000"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "address2": "Suite 1000"
}'

HTTPie

echo '{
  "address2": "Suite 1000"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "address2": "Suite 1000"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

city

JavaScript

jstag.send({
  "city": "New York"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "city": "New York"
}'

HTTPie

echo '{
  "city": "New York"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "city": "New York"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

region

JavaScript

jstag.send({
  "region": "NY"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "region": "NY"
}'

HTTPie

echo '{
  "region": "NY"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "region": "NY"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

country

JavaScript

jstag.send({
  "country": "United States"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "country": "United States"
}'

HTTPie

echo '{
  "country": "United States"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "country": "United States"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

postal_code

JavaScript

jstag.send({
  "postal_code": "10112"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "postal_code": "10112"
}'

HTTPie

echo '{
  "postal_code": "10112"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "postal_code": "10112"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

status

JavaScript

jstag.send({
  "status": "active"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "status": "active"
}'

HTTPie

echo '{
  "status": "active"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "status": "active"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Geo

Geolocation attributes are inferred from geolocation on network activity.

Field	Short Description	Long Description	Example
geoip_location	GeoIP: Location	Latitude, longitude and accuracy of an individual's most recently collected IP address.	{"lat": 47.6062, "long": -122.3321,, "accuracy": 123.0}
geoip_org	GeoIP: Organization	Organization inferred from the most recently observed IP address for an individual. This may correspond to a business name, or an internet service provider in the case of residential IP addresses.	"Acme Corp."
geoip_country	GeoIP: Country	Country inferred from the most recently observed IP address for an individual.	"USA"
geoip_city	GeoIP: City	City inferred from the most recently observed IP address for an individual.	"New York"
geoip_region	GeoIP: Region	Region, state, or province inferred from the most recently observed IP address for an individual.	"NY"
designated_market_area	Designated Market Area	An individual's designated marketing area.	"New York"
timezone	Timezone	Timezone associated with an individual's browser or location.	"-4"

geolocation

JavaScript

jstag.send({
  "ip_address": "192.168.0.1"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "ip_address": "192.168.0.1"
}'

HTTPie

echo '{
  "ip_address": "192.168.0.1"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "ip_address": "192.168.0.1"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

geoip_org

JavaScript

jstag.send({
  "ip_address": "192.168.0.1"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "ip_address": "192.168.0.1"
}'

HTTPie

echo '{
  "ip_address": "192.168.0.1"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "ip_address": "192.168.0.1"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

geoip_country

JavaScript

jstag.send({
  "ip_address": "192.168.0.2"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "ip_address": "192.168.0.2"
}'

HTTPie

echo '{
  "ip_address": "192.168.0.2"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "ip_address": "192.168.0.2"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

geoip_city

JavaScript

jstag.send({
  "ip_address": "192.168.0.3"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "ip_address": "192.168.0.3"
}'

HTTPie

echo '{
  "ip_address": "192.168.0.3"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "ip_address": "192.168.0.3"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

geoip_region

JavaScript

jstag.send({
  "ip_address": "192.168.0.4"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "ip_address": "192.168.0.4"
}'

HTTPie

echo '{
  "ip_address": "192.168.0.4"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "ip_address": "192.168.0.4"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

designated_market_area

JavaScript

jstag.send({
  "dma": "New York"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "dma": "New York"
}'

HTTPie

echo '{
  "dma": "New York"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "dma": "New York"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

timezone

JavaScript

jstag.send({
  "timezone": "-4"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "timezone": "-4"
}'

HTTPie

echo '{
  "timezone": "-4"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "timezone": "-4"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Device

Device attributes describe the devices that have been associated with an individual and their activity.

Field	Short Description	Long Description	Example
device_id	Device ID: Most Recent	An individual's most recent device ID.	"555837ca-cce7-496c-8acc-552793ce969a"
device_ids	Device ID: All	The collection of all of an individual's observed device IDs.	["555837ca-cce7-496c-8acc-552793ce969a"]
device_advertising_id	Device Advertising ID: Most Recent	An individual's most recent device ID.	"AB1234CD-E123-12FG-J123"
device_advertising_ids	Device Advertising ID: All	The collection of all of an individual's device IDs.	["AB1234CD-E123-12FG-J123"]
device_types	Device: Types	The collection of all of an individual's observed device types.	{"desktop": 1, "mobile": 100}
user_agent	User Agent	The most recent user agent of an individual's browser.	"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
is_mobile	Mobile Visitor	A flag to indicate if the user has ever been a mobile visitor.	"FALSE"
is_bot	Is Bot	A flag to indicate whether or not an individual is suspected of being a bot (determined by their user agent).	"FALSE"
device_os	Device: OS	The operating system of an individual's most recent device.	"iOS"
device_model	Device: Model	The model of an individual's most recent device.	"iPhone 15"
browser_hash	Browser: Computed Hash	The set computed hash of an individual's browsers.	["555837ca-cce7-496c-8acc-552793ce969a"]
browser	Browser: Version	The version of an individual's browser.	"Chrome/130.0.0.0"

device_id

JavaScript

jstag.send("555837ca-cce7-496c-8acc-552793ce969a")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"555837ca-cce7-496c-8acc-552793ce969a"'

HTTPie

echo '"555837ca-cce7-496c-8acc-552793ce969a"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("555837ca-cce7-496c-8acc-552793ce969a");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

device_ids

JavaScript

jstag.send("555837ca-cce7-496c-8acc-552793ce969a")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"555837ca-cce7-496c-8acc-552793ce969a"'

HTTPie

echo '"555837ca-cce7-496c-8acc-552793ce969a"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("555837ca-cce7-496c-8acc-552793ce969a");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

device_advertising_id

This may be a Google Advertising ID (GAID) or an Apple Identifier for Advertisers (IDFA).

JavaScript

jstag.send("AB1234CD-E123-12FG-J123")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"AB1234CD-E123-12FG-J123"'

HTTPie

echo '"AB1234CD-E123-12FG-J123"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("AB1234CD-E123-12FG-J123");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

device_advertising_ids

These may be a Google Advertising ID (GAID) or an Apple Identifier for Advertisers (IDFA).

JavaScript

jstag.send("AB1234CD-E123-12FG-J123")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"AB1234CD-E123-12FG-J123"'

HTTPie

echo '"AB1234CD-E123-12FG-J123"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("AB1234CD-E123-12FG-J123");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

device_types

JavaScript

jstag.send("desktop")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"desktop"'

HTTPie

echo '"desktop"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("desktop");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

user_agent

JavaScript

jstag.send({
  "useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
}'

HTTPie

echo '{
  "useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

is_mobile

JavaScript

jstag.send({
  "_uamob": "f"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "_uamob": "f"
}'

HTTPie

echo '{
  "_uamob": "f"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "_uamob": "f"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

is_bot

JavaScript

jstag.send({
  "_uabot": "f"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "_uabot": "f"
}'

HTTPie

echo '{
  "_uabot": "f"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "_uabot": "f"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

device_os

JavaScript

jstag.send({
  "device_os": "iOS"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "device_os": "iOS"
}'

HTTPie

echo '{
  "device_os": "iOS"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "device_os": "iOS"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

device_model

JavaScript

jstag.send({
  "device_model": "iPhone 15"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "device_model": "iPhone 15"
}'

HTTPie

echo '{
  "device_model": "iPhone 15"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "device_model": "iPhone 15"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

browser_hash

While not a default part of your identity graph, this field may be promoted to an identifier to perform identity stitching. This should be performed with caution as it is not guaranteed to be unique and can result in stitching individuals with similarly configured browser.

JavaScript

jstag.send({
  "browser_hash": "555837ca-cce7-496c-8acc-552793ce969a"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "browser_hash": "555837ca-cce7-496c-8acc-552793ce969a"
}'

HTTPie

echo '{
  "browser_hash": "555837ca-cce7-496c-8acc-552793ce969a"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "browser_hash": "555837ca-cce7-496c-8acc-552793ce969a"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

browser

JavaScript

jstag.send("Chrome/130.0.0.0")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"Chrome/130.0.0.0"'

HTTPie

echo '"Chrome/130.0.0.0"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("Chrome/130.0.0.0");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Attribution

Field	Short Description	Long Description	Example
utm_campaign	UTM Campaign: Most Recent	An individual's most recently observed UTM campaign.	"mycampaign1"
utm_campaigns	UTM Campaign: All	The set of an individual's N most recently observed UTM campaigns.	["mycampaign1", "mycampaign0"]
utm_source	UTM Source: Most Recent	An individual's most recently observed UTM source.	"instagram"
utm_sources	UTM Campaign: All	The set of an individual's N most recently observed UTM sources.	["instagram", "google"]
utm_term	UTM Term: Most Recent	An individual's most recently observed UTM term.	"winter coats"
utm_terms	UTM Campaign: All	The set of an individual's N most recently observed UTM terms.	["winter coats"]
utm_content	UTM Content: Most Recent	An individual's most recently observed UTM content.	"spanish"
utm_contents	UTM Content: All	The set of an individual's N most recently observed UTM contents.	["spanish"]
utm_medium	UTM Medium: Most Recent	An individual's most recently observed UTM medium.	"paid"
utm_mediums	UTM Campaign: All	The set of an individual's N most recently observed UTM mediums.	["paid"]
ly_impressions	Attribution: Impressions	A map of campaign impressions for an individual for Lytics-managed campaigns.	{"content-rec-modal": 10}
ly_conversions	Attribution: Conversions	A map of campaign conversions for an individual for Lytics-managed campaigns.	{"content-rec-modal": 2}
ly_closes	Attribution: Closes	A map of campaign closes for an individual for Lytics-managed campaigns.	{"content-rec-modal": 7}
ly_cancels	Attribution: Cancels	A map of campaign cancels for an individual for Lytics-managed campaigns.	{"content-rec-modal": 1}
ly_hover	Attribution: Hovered	A map of campaign hovers for an individual for Lytics-managed campaigns.	{"content-rec-modal": 5}
conversions_ts	Conversion Events	A map of conversion events of an individual, by timestamp.	{"content-rec-modal": "2024-02-28T02:45:51.377423153Z"}
impressions_ts	Impression Events	A map of impression events of an individual, by timestamp.	{"content-rec-modal": "2024-02-28T02:45:51.377423153Z"}

utm_campaign

JavaScript

jstag.send({
  "utm_campaign": "mycampaign1"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_campaign": "mycampaign1"
}'

HTTPie

echo '{
  "utm_campaign": "mycampaign1"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_campaign": "mycampaign1"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_campaigns

JavaScript

jstag.send({
  "utm_campaign": "mycampaign1"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_campaign": "mycampaign1"
}'

HTTPie

echo '{
  "utm_campaign": "mycampaign1"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_campaign": "mycampaign1"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_source

JavaScript

jstag.send({
  "utm_source": "instagram"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_source": "instagram"
}'

HTTPie

echo '{
  "utm_source": "instagram"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_source": "instagram"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_sources

JavaScript

jstag.send({
  "utm_source": "instagram"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_source": "instagram"
}'

HTTPie

echo '{
  "utm_source": "instagram"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_source": "instagram"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_term

JavaScript

jstag.send({
  "utm_term": "winter coats"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_term": "winter coats"
}'

HTTPie

echo '{
  "utm_term": "winter coats"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_term": "winter coats"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_terms

JavaScript

jstag.send({
  "utm_term": "winter coats"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_term": "winter coats"
}'

HTTPie

echo '{
  "utm_term": "winter coats"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_term": "winter coats"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_content

JavaScript

jstag.send({
  "utm_content": "spanish"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_content": "spanish"
}'

HTTPie

echo '{
  "utm_content": "spanish"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_content": "spanish"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_contents

JavaScript

jstag.send({
  "utm_content": "spanish"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_content": "spanish"
}'

HTTPie

echo '{
  "utm_content": "spanish"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_content": "spanish"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_medium

JavaScript

jstag.send({
  "utm_medium": "paid"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_medium": "paid"
}'

HTTPie

echo '{
  "utm_medium": "paid"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_medium": "paid"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

utm_mediums

JavaScript

jstag.send({
  "utm_medium": "paid"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "utm_medium": "paid"
}'

HTTPie

echo '{
  "utm_medium": "paid"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "utm_medium": "paid"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

ly_impressions

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

ly_conversions

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

ly_closes

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

ly_cancels

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

ly_hover

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

conversions_ts

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

impressions_ts

JavaScript

jstag.send({
  "pf-widget-id": "content-rec-modal"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "pf-widget-id": "content-rec-modal"
}'

HTTPie

echo '{
  "pf-widget-id": "content-rec-modal"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "pf-widget-id": "content-rec-modal"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Demographic

Field	Short Description	Long Description	Example
gender	Gender	An individual's gender.	"F"
age	Age	An individual's age.	38
locale	Locale	An individual's locale, often determined by their browser.	"en_US"
language	Language Code	An individual's language, often determined by their browser.	"en"

gender

JavaScript

jstag.send({
  "gender": "F"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "gender": "F"
}'

HTTPie

echo '{
  "gender": "F"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "gender": "F"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

age

JavaScript

jstag.send({
  "age": 38
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "age": 38
}'

HTTPie

echo '{
  "age": 38
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "age": 38
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

locale

An individual's locale is usually a combination of an individual's language code and country code.

JavaScript

jstag.send({
  "locale": "en_US"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "locale": "en_US"
}'

HTTPie

echo '{
  "locale": "en_US"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "locale": "en_US"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

language

An individual's language code, standardized by ISO-639-1 two-letter codes.

JavaScript

jstag.send({
  "locale": "en_US"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "locale": "en_US"
}'

HTTPie

echo '{
  "locale": "en_US"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "locale": "en_US"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

First Party

Field	Short Description	Long Description	Example
user_attributes	User Attributes	A map of custom properties for a profile.	{"role": "member", "status": "active"}
form_data	Form Data	A map to store custom form data for a profile.	{"field1": "value1", "field2": "value2"}

user_attributes

User Attributes are helpful for storing custom attributes about an individual without having to create and map additional user fields.

JavaScript

jstag.send({
  "attr": {
    "status": "active"
  }
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "attr": {
    "status": "active"
  }
}'

HTTPie

echo '{
  "attr": {
    "status": "active"
  }
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "attr": {
    "status": "active"
  }
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

form_data

Form Data is helpful for storing custom form data from an individual without having to create and map additional user fields.

JavaScript

jstag.send({
  "form": {
    "field1": "value1"
  }
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "form": {
    "field1": "value1"
  }
}'

HTTPie

echo '{
  "form": {
    "field1": "value1"
  }
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "form": {
    "field1": "value1"
  }
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Behaviors

Field	Short Description	Long Description	Example
hourly	Activity by Hour	A count of an individual's activity by the hour of the day.	{"9": 1, "12": 4, "22": 1}
hourofweek	Activity by Hour of Week	A count of an individual's activity by the hour of the week.	{"2": 2, "140": 3, "167": 9}

hourly

hourly utilized the timestamp of the event being collected, and does not require any mappings.

JavaScript

jstag.send({
  "foo": "bar"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "foo": "bar"
}'

HTTPie

echo '{
  "foo": "bar"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "foo": "bar"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

hourofweek

hourofweek utilized the timestamp of the event being collected, and does not require any mappings.

JavaScript

jstag.send({
  "foo": "bar"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "foo": "bar"
}'

HTTPie

echo '{
  "foo": "bar"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "foo": "bar"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Governance

Field	Short Description	Long Description	Example
consent_status	Consent Status	A map of consented marketing channels, and content status.	{"web_necessary": "consented"}
consent_status_ts	Consent Status (Timestamp)	A map of consented marketing channels, and when that status was updated.	{"web_necessary": "2024-02-28T02:45:51.377423153Z"}
consent_status_source	Consent Status (Source)	A map of consented marketing channels, and the source from which the consent came.	{"web_necessary": "onetrust"}

consent_status

The marketing tracking and activation channels to which an individual has expressly given consent. This typically includes the following values: "email_marketing", "sms_marketing", "push_marketing", "cookies_necessary", "cookies_performance", "web_functional", "web_targeting", "web_social".

JavaScript

jstag.send({
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
}'

HTTPie

echo '{
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

consent_status_ts

The time at which the consent has most recently been confirmed.

JavaScript

jstag.send({
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
}'

HTTPie

echo '{
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

consent_status_source

The source of the consent status.

JavaScript

jstag.send({
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
}'

HTTPie

echo '{
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "consent": {
    "purpose": "c0001",
    "constented": "true"
  }
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

B2B

Field	Short Description	Long Description	Example
job_title	Job Title	An individual's job title.	"CEO"
job_role	Job Role	An individual's job role.	"Executive"
company_name	Company Name	The name of the company at which an individual is employed.	"Lytics, Inc."
company_size	Company Size	The number of employess of the company at which an individual is employed.	224
company_revenue	Company Revenue	The annual revenue of the company at which an individual is employed.	5e+08
company_industry	Company Industry	The industry of the company at which an individual is employed.	"Healthcare"
phone_business	Business Phone	The phone number of the company at which an individual is employed.	"555-555-5555"

job_title

JavaScript

jstag.send("CEO")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"CEO"'

HTTPie

echo '"CEO"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("CEO");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

job_role

JavaScript

jstag.send("Executive")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"Executive"'

HTTPie

echo '"Executive"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("Executive");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

company_name

JavaScript

jstag.send("Lytics, Inc.")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"Lytics, Inc."'

HTTPie

echo '"Lytics, Inc."' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("Lytics, Inc.");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

company_size

JavaScript

jstag.send(224)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '224'

HTTPie

echo '224' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(224);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

company_revenue

JavaScript

jstag.send(5e+08)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '5e+08'

HTTPie

echo '5e+08' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(5e+08);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

company_industry

JavaScript

jstag.send("Healthcare")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"Healthcare"'

HTTPie

echo '"Healthcare"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("Healthcare");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

phone_business

JavaScript

jstag.send("555-555-5555")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"555-555-5555"'

HTTPie

echo '"555-555-5555"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("555-555-5555");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Field	Short Description	Long Description	Example
facebook_id	Facebook ID	An individual's Facebook ID.	"jane.doe33"
twitter_id	Twitter ID	An individual's X (Twitter) ID.	"potus"
pinterest_id	Pinterest ID	An individual's Pinterest ID.	1234567891234
linkedin_id	LinkedIn ID	An Individual's LinkedIn ID.	"jeff-dean-8b212555"
tiktok_id	TikTok ID	An Individual's TikTok ID.	"bts_official_bighit"

facebook_id

JavaScript

jstag.send("jane.doe33")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"jane.doe33"'

HTTPie

echo '"jane.doe33"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("jane.doe33");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

twitter_id

JavaScript

jstag.send("potus")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"potus"'

HTTPie

echo '"potus"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("potus");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

pinterest_id

JavaScript

jstag.send(1234567891234)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '1234567891234'

HTTPie

echo '1234567891234' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(1234567891234);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

linkedin_id

JavaScript

jstag.send("jeff-dean-8b212555")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"jeff-dean-8b212555"'

HTTPie

echo '"jeff-dean-8b212555"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("jeff-dean-8b212555");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

tiktok_id

JavaScript

jstag.send("bts_official_bighit")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"bts_official_bighit"'

HTTPie

echo '"bts_official_bighit"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("bts_official_bighit");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Channels

Field	Short Description	Long Description	Example
channel_activity_first_ts	Activity By Channel: First/Oldest	The earliest observed activity for an individual in a channel.	{"web": "2024-09-13T20:34:17.546Z"}
channel_activity_last_ts	Activity By Channel: Most Recent	The most recently observed activity for an individual in a channel.	{"web": "2023-01-11T20:22:57.249Z"}

channel_activity_first_ts

JavaScript

jstag.send({
  "channel": "web",
  "timestamp": "2024-09-13T20:34:17.546Z"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "channel": "web",
  "timestamp": "2024-09-13T20:34:17.546Z"
}'

HTTPie

echo '{
  "channel": "web",
  "timestamp": "2024-09-13T20:34:17.546Z"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "channel": "web",
  "timestamp": "2024-09-13T20:34:17.546Z"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

channel_activity_last_ts

JavaScript

jstag.send({
  "channel": "web",
  "timestamp": "2023-01-11T20:22:57.249Z"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "channel": "web",
  "timestamp": "2023-01-11T20:22:57.249Z"
}'

HTTPie

echo '{
  "channel": "web",
  "timestamp": "2023-01-11T20:22:57.249Z"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "channel": "web",
  "timestamp": "2023-01-11T20:22:57.249Z"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Web

Field	Short Description	Long Description	Example
_uid	Web Cookie Id: Current	The most recently observed cookie for an individual's browser, as generated by Lytics' JSTag.	"50b772f5-a0be-42f2-8828-84b8db5d5a23"
refdomain	Web Referrer Domains	The set of referring web domains for an individual.	["facebook.com"]
action_web_count	Web Actions: Count	A set of counts of various activities observed in web sources.	{"pageview": 45}
action_web_ts	Web Actions: Most Recent	A set of the most recent timestamps of various activities observed in the billing sources.	{"pageview": "2024-09-10T12:00:00Z"}
analytics_cohorts	Analytics Cohorts	A set of the analytics cohorts of which an individual is a member	["group1", "group2"]

_uid

JavaScript

jstag.send("50b772f5-a0be-42f2-8828-84b8db5d5a23")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"50b772f5-a0be-42f2-8828-84b8db5d5a23"'

HTTPie

echo '"50b772f5-a0be-42f2-8828-84b8db5d5a23"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("50b772f5-a0be-42f2-8828-84b8db5d5a23");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

refdomain

JavaScript

jstag.send("facebook.com")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"facebook.com"'

HTTPie

echo '"facebook.com"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("facebook.com");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_web_count

JavaScript

jstag.send({
  "action": "pageview"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "pageview"
}'

HTTPie

echo '{
  "action": "pageview"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "pageview"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_web_ts

JavaScript

jstag.send({
  "action": "pageview"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "pageview"
}'

HTTPie

echo '{
  "action": "pageview"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "pageview"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

analytics_cohorts

JavaScript

jstag.send([
  "group1",
  "group2"
])

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '[
  "group1",
  "group2"
]'

HTTPie

echo '[
  "group1",
  "group2"
]' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify([
  "group1",
  "group2"
]);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Email

Field	Short Description	Long Description	Example
email_domain	Email Address: Domain	The domain of an individual's email address (gmail.com, mail.google.com, lytics.com, etc.).	lytics.com
email_list_ids	Email Lists	The email lists to which an individual is subscribed.	{"newsletter": "subscribed"}
email_status	Email Subscriber Status	Optional, provides a generic subscriber status for an individual.	"active"
action_email_count	Email Actions: Count	A set of counts of various activities observed in email sources.	{"open": 45}
action_email_ts	Email Actions: Most Recent	A set of the most recent timestamps of various activities observed in email sources.	{"open": "2024-09-10T12:00:00Z"}

email_domain

JavaScript

jstag.send({
  "email_address": "[email protected]"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "email_address": "[email protected]"
}'

HTTPie

echo '{
  "email_address": "[email protected]"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "email_address": "[email protected]"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

email_list_ids

JavaScript

jstag.send({
  "list": "newsletter",
  "status": "subscribed"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "list": "newsletter",
  "status": "subscribed"
}'

HTTPie

echo '{
  "list": "newsletter",
  "status": "subscribed"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "list": "newsletter",
  "status": "subscribed"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

email_status

JavaScript

jstag.send("active")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"active"'

HTTPie

echo '"active"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("active");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_email_count

JavaScript

jstag.send({
  "action": "open"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "open"
}'

HTTPie

echo '{
  "action": "open"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "open"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_email_ts

JavaScript

jstag.send({
  "action": "open"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "open"
}'

HTTPie

echo '{
  "action": "open"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "open"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

SMS

Field	Short Description	Long Description	Example
action_sms_count	SMS Actions: Count	A set of counts of various activities observed in SMS sources.	{"send": 45}
action_sms_ts	SMS Actions: Most Recent	A set of the most recent timestamps of various activities observed in SMS sources.	{"send": "2024-09-10T12:00:00Z"}
mobile_carrier	Mobile Carrier	An individual's mobile carrier.	"vodafone"

action_sms_count

JavaScript

jstag.send({
  "action": "send"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "send"
}'

HTTPie

echo '{
  "action": "send"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "send"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_sms_ts

JavaScript

jstag.send({
  "action": "send"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "send"
}'

HTTPie

echo '{
  "action": "send"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "send"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

mobile_carrier

JavaScript

jstag.send("vodafone")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"vodafone"'

HTTPie

echo '"vodafone"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("vodafone");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

App

Field	Short Description	Long Description	Example
app_version	Mobile App: Version	The version of the app an individual is using.	"12.0.1"
action_push_count	Mobile Push Actions: Count	A set of counts of various activities observed in push sources.	{"open": 45}
action_push_ts	Mobile Push Actions: Most Recent	A set of the most recent timestamps of various activities observed in push sources.	{"open": "2024-09-10T12:00:00Z"}
action_app_count	Mobile App Actions: Count	A set of counts of various activities observed in app sources.	{"open": 45}
action_app_ts	Mobile App Actions: Most Recent	A set of the most recent timestamps of various activities observed in app sources.	{"open": "2024-09-10T12:00:00Z"}

app_version

JavaScript

jstag.send("12.0.1")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"12.0.1"'

HTTPie

echo '"12.0.1"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("12.0.1");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_push_count

JavaScript

jstag.send({
  "action": "open"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "open"
}'

HTTPie

echo '{
  "action": "open"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "open"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_push_ts

JavaScript

jstag.send({
  "action": "open"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "open"
}'

HTTPie

echo '{
  "action": "open"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "open"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_app_count

JavaScript

jstag.send({
  "action": "open"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "open"
}'

HTTPie

echo '{
  "action": "open"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "open"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_app_ts

JavaScript

jstag.send({
  "action": "open"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "open"
}'

HTTPie

echo '{
  "action": "open"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "open"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Chat

Field	Short Description	Long Description	Example
action_chat_count	Chat Actions: Count	A set of counts of various activities observed in chat sources.	{"reply": 45}
action_chat_ts	Chat Actions: Most Recent	A set of the most recent timestamps of various activities observed in chat sources.	{"reply": "2024-09-10T12:00:00Z"}

action_chat_count

JavaScript

jstag.send({
  "action": "reply"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "reply"
}'

HTTPie

echo '{
  "action": "reply"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "reply"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_chat_ts

JavaScript

jstag.send({
  "action": "reply"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "reply"
}'

HTTPie

echo '{
  "action": "reply"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "reply"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Retail

Field	Short Description	Long Description	Example
tax_exempt	Tax Exempt	Whether an individual is tax exempt.	FALSE
currency	Currency	An individual's most recently used currency.	"usd"
purchase_total	Purchase Total	An individual's total purchase amount from retail sources, in that individual's currency.	142.01
purchase_count	Purchase Count	An individual's total number of purchases from retail sources.	2
purchase_shop_total	Purchase Total by Shop	Total amount spent by each shop.	{"mystore": 123.45}
purchase_shop_count	Purchase Count by Shop	Total number of purchases by each shop's name.	{"mystore": 2}
action_retail_count	Retail Actions: Count	A set of counts of various activities observed in retail sources.	{"refund": 45}
action_retail_ts	Retail Actions: Most Recent	A set of the most recent timestamps of various activities observed in retail sources.	{"refund": "2024-09-10T12:00:00Z"}
product_ids	Product IDs Ordered	The set of product IDs an individual has ordered.	["abc123"]
order_ids	Order IDs	The set of order IDs of an individual's order history.	["1294322"]

tax_exempt

JavaScript

jstag.send("false")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"false"'

HTTPie

echo '"false"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("false");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

currency

JavaScript

jstag.send("usd")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"usd"'

HTTPie

echo '"usd"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("usd");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

purchase_total

JavaScript

jstag.send(142.01)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '142.01'

HTTPie

echo '142.01' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(142.01);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

purchase_count

JavaScript

jstag.send(2)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '2'

HTTPie

echo '2' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(2);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

purchase_shop_total

JavaScript

jstag.send({
  "shop_name": "mystore",
  "total_spent": 123.45
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "shop_name": "mystore",
  "total_spent": 123.45
}'

HTTPie

echo '{
  "shop_name": "mystore",
  "total_spent": 123.45
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "shop_name": "mystore",
  "total_spent": 123.45
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

purchase_shop_count

JavaScript

jstag.send({
  "shop_name": "mystore"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "shop_name": "mystore"
}'

HTTPie

echo '{
  "shop_name": "mystore"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "shop_name": "mystore"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_retail_count

JavaScript

jstag.send({
  "action": "refund"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "refund"
}'

HTTPie

echo '{
  "action": "refund"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "refund"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_retail_ts

JavaScript

jstag.send({
  "action": "refund"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "refund"
}'

HTTPie

echo '{
  "action": "refund"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "refund"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

product_ids

JavaScript

jstag.send("abc123")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"abc123"'

HTTPie

echo '"abc123"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("abc123");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

order_ids

JavaScript

jstag.send("1294322")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"1294322"'

HTTPie

echo '"1294322"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("1294322");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

CRM

Field	Short Description	Long Description	Example
account_id	Account ID	The account ID associated with an individual.	"acme-corp-123"
lead_status	Lead Status	The lead status associated with an individual.	"open"
lead_source	Lead Source	The lead source associated with an individual.	"blog"
lead_score	Lead Score	The lead score associated with an individual.	0.72
lifecycle_stage	Lifecycle Stage	An individual's lifecycle stage.	"loyal"
opportunity_value	Opportunity Value	The opportunity value of an individual.	50000

account_id

JavaScript

jstag.send("acme-corp-123")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"acme-corp-123"'

HTTPie

echo '"acme-corp-123"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("acme-corp-123");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

lead_status

JavaScript

jstag.send("open")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"open"'

HTTPie

echo '"open"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("open");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

lead_source

JavaScript

jstag.send("blog")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"blog"'

HTTPie

echo '"blog"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("blog");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

lead_score

JavaScript

jstag.send(0.72)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '0.72'

HTTPie

echo '0.72' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(0.72);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

lifecycle_stage

JavaScript

jstag.send("loyal")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"loyal"'

HTTPie

echo '"loyal"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("loyal");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

opportunity_value

JavaScript

jstag.send(50000)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '50000'

HTTPie

echo '50000' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(50000);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Survey

Field	Short Description	Long Description	Example
survey_responses	Survey Responses	A collection of the individual's survey responses.	{"nps":"promoter"}

survey_responses

JavaScript

jstag.send({
  "nps": "promoter"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "nps": "promoter"
}'

HTTPie

echo '{
  "nps": "promoter"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "nps": "promoter"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Support

Field	Short Description	Long Description	Example
action_survey_count	Support Actions: Count	A set of counts of various activities observed in survey sources.	{"respond": 45}
action_survey_ts	Support Actions: Most Recent	A set of the most recent timestamps of various activities observed in survey sources.	{"respond": "2024-09-10T12:00:00Z"}
csat_score	Customer Satisfaction Score	An individual's current customer satistfaction score.	24
support_ticket_status	Current Support Ticket Status	An individual's support ticket status.	"open"

action_survey_count

JavaScript

jstag.send({
  "action": "respond"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "respond"
}'

HTTPie

echo '{
  "action": "respond"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "respond"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_survey_ts

JavaScript

jstag.send({
  "action": "respond"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "respond"
}'

HTTPie

echo '{
  "action": "respond"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "respond"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

csat_score

JavaScript

jstag.send(24)

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '24'

HTTPie

echo '24' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify(24);
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

support_ticket_status

JavaScript

jstag.send("open")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"open"'

HTTPie

echo '"open"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("open");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Billing

Field	Short Description	Long Description	Example
action_billing_count	Billing Actions: Count	A set of counts of various activities observed in billing sources.	{"paid": 45}
action_billing_ts	Billing Actions: Most Recent	A set of the most recent timestamps of various activities observed in billing sources.	{"paid": "2024-09-10T12:00:00Z"}

action_billing_count

JavaScript

jstag.send({
  "action": "paid"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "paid"
}'

HTTPie

echo '{
  "action": "paid"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "paid"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

action_billing_ts

JavaScript

jstag.send({
  "action": "paid"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "action": "paid"
}'

HTTPie

echo '{
  "action": "paid"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "action": "paid"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

Media

Field	Short Description	Long Description	Example
subscription_status	Subscription Status	An individual's subscription status.	"active"
subscription_start	Subscription Term Start	The start date of an individual's most recent subscription.	"2024-02-28"
subscription_end	Subscription Term End	The end date of an individual's most recent subscription.	"2025-02-28"

subscription_status

JavaScript

jstag.send("active")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"active"'

HTTPie

echo '"active"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("active");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

subscription_start

JavaScript

jstag.send("2024-02-28")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"2024-02-28"'

HTTPie

echo '"2024-02-28"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("2024-02-28");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

subscription_end

JavaScript

jstag.send("2025-02-28")

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '"2025-02-28"'

HTTPie

echo '"2025-02-28"' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify("2025-02-28");
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

JavaScript

jstag.send({
  "subscription_start": "2024-02-28"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "subscription_start": "2024-02-28"
}'

HTTPie

echo '{
  "subscription_start": "2024-02-28"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "subscription_start": "2024-02-28"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});

subscription_end

JavaScript

jstag.send({
  "subscription_end": "2025-02-28"
})

cURL

curl --request POST  
  --url https://api.lytics.io/collect/json/default  
  --header 'accept: application/json'  
  --header 'authorization: API_KEY'  
  --header 'content-type: */*'  
  --data '{
  "subscription_end": "2025-02-28"
}'

HTTPie

echo '{
  "subscription_end": "2025-02-28"
}' | http post htps://api.lytics.io/collect/json/default Authorization:API_KEY

Postman

pm.request.headers.add({
    key: "Authorization",
    value: "<API_KEY>"
});
pm.request.body.raw = JSON.stringify({
  "subscription_end": "2025-02-28"
});
pm.sendRequest({
    url: "https://api.lytics.io/collect/json/default",
    method: "POST",
});