Meta tags:
description= Learn about Customer.io s Track API to programmatically add people to your audience and trigger campaigns based on customer behavior.;
Headings (most frequently used words):
api, collapsed, limits, track, v2, customer, overview, and, authentication, v1, vs, io, reference, journeys, use, our, postman, collection, server, addresses, us, eu, apis, rate, download, the, openapi, spec, for, this, all, specifications, ai, agent, friendly, resources, object, relationship, event, web, sdk, backend, integrations, account, region, customers, events, segments, forms, models, make, single, request, send, multiple, requests,
Text of the page (most frequently used words):
and (99), the (86), app (84), api (83), push (79), messages (76), your (73), track (66), people (63), events (58), you (53), for (52), data (51), #customer (46), started (45), identify (41), set (41), notifications (39), with (38), email (32), use (31), get (31), our (30), metrics (29), send (28), troubleshooting (26), object (24), event (24), from (23), tracking (23), message (23), attributes (22), account (22), how (22), objects (22), segments (21), person (21), post (19), can (19), type (19), request (19), batch (19), json (19), multiple (19), links (19), campaigns (18), add (18), create (18), that (18), customers (18), requests (18), copy (17), anonymous (17), authentication (17), mobile (17), changelog (17), getting (17), are (16), this (16), link (15), using (15), attribute (15), integrations (15), test (15), update (15), limits (15), start (15), users (14), what (14), forms (13), apis (13), javascript (13), custom (13), listeners (13), deep (13), campaign (13), action (12), each (12), journeys (12), activity (12), quick (12), guide (12), inbox (12), google (12), more (11), page (11), screen (11), max (11), manage (11), capture (11), options (11), subscription (11), show (10), endpoints (10), works (10), server (10), inline (10), android (10), channels (10), lifecycle (10), webhooks (10), support (9), emails (9), length (9), overview (9), one (9), content (9), edit (9), handling (9), providers (9), new (9), configuration (9), migrate (9), advanced (9), editor (9), transactional (9), operations (8), out (8), these (8), identifiers (8), delete (8), region (8), based (8), status (8), entity (8), time (8), version (8), bytes (8), pipelines (8), open (8), group (8), reference (8), privacy (8), notification (8), liquid (8), workspace (7), segment (7), identifier (7), snippet (7), want (7), name (7), make (7), all (7), single (7), updates (7), integration (7), addresses (7), security (7), flutter (7), packages (7), components (7), trigger (6), website (6), collapsed (6), both (6), backend (6), best (6), integrate (6), but (6), array (6), smaller (6), timestamp (6), relationships (6), rate (6), postman (6), collection (6), sms (6), ios (6), react (6), native (6), design (6), studio (6), amazon (6), introduction (6), inbound (6), conditions (6), must (5), not (5), workspaces (5), directly (5), when (5), have (5), understand (5), like (5), plan (5), may (5), https (5), call (5), response (5), application (5), invalid (5), required (5), values (5), two (5), libraries (5), limit (5), groups (5), their (5), features (5), about (5), analysis (5), service (5), practices (5), billing (5), whatsapp (5), location (5), earlier (5), rules (5), frequently (5), asked (5), questions (5), legacy (5), hubspot (5), actions (5), code (5), syntax (5), welcome (5), css (5), sending (5), triggered (5), broadcasts (5), workflows (5), responses (4), manual (4), suppress (4), devices (4), also (4), center (4), site (4), basic (4), why (4), script (4), _cio (4), web (4), successful (4), returns (4), empty (4), body (4), 401 (4), 400 (4), 200 (4), other (4), errors (4), any (4), 32kb (4), types (4), non (4), operation (4), change (4), relationship (4), below (4), size (4), number (4), 150 (4), performance (4), common (4), settings (4), builder (4), agent (4), rich (4), messaging (4), conversions (4), snowflake (4), reporting (4), storage (4), bigquery (4), redshift (4), webhook (4), understanding (4), tests (4), recipes (4), statuses (4), preferences (4), global (4), component (4), faq (4), styles (4), opt (4), layouts (4), domain (4), branches (4), filters (4), style (4), apply (3), form (3), note (3), lists (3), associate (3), unsuppress (3), accounts (3), key (3), another (3), load (3), they (3), work (3), don (3), cases (3), assets (3), true (3), document (3), var (3), function (3), acme (3), example (3), right (3), credentials (3), was (3), child (3), individual (3), payload (3), than (3), within (3), limited (3), only (3), course (3), represents (3), auth (3), aren (3), used (3), sent (3), between (3), deliveries (3), has (3), supports (3), select (3), client (3), url (3), description (3), per (3), 1000 (3), lead (3), help (3), rudderstack (3), find (3), http (3), authorization (3), servers (3), services (3), release (3), documentation (3), openapi (3), method (3), docs (3), mcp (3), beta (3), conversion (3), assign (3), roles (3), standard (3), upgrade (3), expo (3), implementation (3), certificates (3), visual (3), twilio (3), slack (3), salesforce (3), mixpanel (3), facebook (3), ads (3), cohorts (3), triggers (3), map (3), reverse (3), etl (3), policy (3), live (3), deliverability (3), broadcast (3), goals (3), personalize (3), files (3), multi (3), templates (3), surveys (3), phone (3), preview (3), drag (3), drop (3), smtp (3), workflow (3), export (3), via (3), csv (3), models (2), submit (2), connect (2), who (2), segment_id (2), remove (2), let (2), modify (2), driven (2), them (2), unsubscribe (2), put (2), referred (2), base (2), either (2), rather (2), doesn (2), system (2), will (2), visited (2), days (2), party (2), setattribute (2), cio (2), text (2), sdk (2), 207 (2), cio_relationships (2), add_relationships (2), object_id (2), object_type_id (2), jane (2), first_name (2), unauthorized (2), sure (2), provided (2), malformed (2), list (2), 500kb (2), company (2), educational (2), enroll (2), etc (2), endpoint (2), lets (2), different (2), delivery (2), pass (2), properties (2), defined (2), control (2), perform (2), const (2), enum (2), kind (2), including (2), managing (2), specific (2), shell (2), python (2), node (2), which (2), total (2), 100 (2), allowed (2), 300 (2), unique (2), names (2), own (2), value (2), contact (2), know (2), adjust (2), periods (2), high (2), could (2), historical (2), backfill (2), batching (2), integrating (2), third (2), information (2), uses (2), generate (2), tokens (2), requires (2), traffic (2), through (2), address (2), european (2), default (2), need (2), variables (2), option (2), changes (2), notes (2), close (2), survey (2), suggestions (2), setup (2), cli (2), feedback (2), browser (2), issues (2), store (2), cookies (2), expiration (2), search (2), team (2), members (2), tasks (2), logs (2), verification (2), provisional (2), sound (2), sdks (2), html (2), comparing (2), pixel (2), sendgrid (2), azure (2), blob (2), cloud (2), audiences (2), braze (2), amplitude (2), connections (2), past (2), mode (2), classic (2), deleting (2), postgresql (2), mysql (2), microsoft (2), sql (2), filter (2), incoming (2), csp (2), proxying (2), disconnect (2), video (2), semantic (2), compliance (2), results (2), dashboard (2), personalization (2), library (2), brand (2), adding (2), parameters (2), localization (2), line (2), activities (2), respond (2), feature (2), adoption (2), upcoming (2), promotions (2), nps (2), display (2), flow (2), build (2), sender (2), validate (2), senders (2), headers (2), adapting (2), template (2), resources (2), relay (2), zone (2), reusable (2), exit (2), llm (2), concepts (2), newsletters (2), reminders (2), trial (2), book (2), frequencies (2), collaborate (2), automation (2), connected (2), review (2), accessibility (2), shortcuts (2), segmentation (2), collections (2), import (2), index (2), releases (2), friendly (2), form_id, fill, remove_customers, add_customers, exist, before, yet, incorporate, uploading, csvs, later, merge_customers, delivery_id, device_id, determine, whether, hosted, should, decision, fully, approach, would, slowing, down, frontend, asynchronous, affect, initial, very, small, few, well, together, interact, haven, blockers, becoming, prevalent, browsers, increasingly, try, avoid, 3rd, trackers, simply, paste, behaviors, many, easier, there, several, reasons, systems, consuming, insertbefore, parentnode, src, params, your_site_id, tracker, async, getelementsbytagname, createelement, sidentify, arguments, slice, prototype, concat, return, admin, role, relationship_attributes, seats, enterprise, corp, premium, doe, last_name, entire, least, accepted, contains, where, modifying, mix, containing, object_relationships, _relationships, reserved, unix, occurred, order, rapid, succession, 1772013598, integer, schema, details, cannot, cio_id, modifies, indicates, item, specified, discriminator, signed, product, merge, delete_device, add_device, delete_relationships, chart, broken, dropdown, see, structure, same, unlike, affecting, grouping, mechanism, belong, online, edge, majority, traditional, then, some, keys, curl, clients, php, ruby, selected, user, secret, password, 100000, associated, kilobytes, similar, often, too, restrictive, needs, situation, able, accommodate, special, circumstances, subject, thresholds, ensure, stable, while, strictly, enforced, consistently, exceeding, throttling, dropped, especially, during, detect, sustained, volume, impact, rare, temporarily, block, second, active, scripts, applies, newer, important, natively, suggest, newest, platform, cdp, most, talk, talking, because, isn, rarely, built, parties, much, encounter, bearer, supporting, scopes, references, header, redirect, accordingly, still, passes, logged, hosts, united, states, union, appropriate, app_api_url, track_api_url, fork, might, disable, automatically, whenever, even, happens, daily, being, flooded, check, watch, original, generated, provides, ways, real, identification, menu, powered, scalar, loading, cursor, ides, claude, chatgpt, command, routines, skills, ask, har, file, login, qualifications, respecting, gdpr, allowlist, session, case, sensitivity, timezone, enable, experimental, regions, sign, sso, factor, customize, switch, canceling, payment, problems, reducing, overages, credits, bill, audit, channel, swift, zendesk, yandex, wisepops, optimizer, vwo, twitter, engage, tiktok, talon, sprig, marketing, saleswings, ripe, qualtrics, playerzero, pipedrive, pinterest, moengage, metronome, meta, logrocket, livelike, launchdarkly, koala, intercom, heap, tag, manager, gtm, sheets, analytics, gtag, gainsight, fullstory, friendbuy, criteo, cordial, commandbar, clevertap, bing, attio, algolia, insights, adobe, target, actable, predictive, resend, filtering, mapping, database, warehouse, zoho, zapier, mparticle, platforms, calculator, scheduled, syncs, transform, utility, methods, identity, management, identities, frameworks, wordpress, wpforms, webflow, unbounce, typeform, squarespace, jotform, formstack, sources, playback, chat, ecommerce, fields, alias, source, specs, directory, failed, attempted, conclusive, reports, home, composer, reusing, snippets, drafts, image, requirements, outside, language, preference, faqs, pages, unsubscribes, universal, checking, translations, translate, languages, milestones, achievements, promote, offers, localize, step, compose, hipaa, regulations, registration, compliant, register, numbers, keyword, smart, character, encoding, keywords, shortening, mms, payloads, registering, device, provider, trustpilot, reviews, gmail, does, fake, bcc, preheader, avatar, logo, mailchimp, column, foundation, view, amp, pre, processing, archive, customizing, basics, choose, editors, oracle, dyn, sparkpost, postmark, mandrill, mailjet, mailgun, verify, deliverable, kickbox, anonymized, authenticating, apple, private, rfc, 8058, postmaster, tools, suppression, suppressions, spamhaus, blocklist, listings, shared, dedicated, warming, attachments, creating, transitioning, supported, formats, zones, recommended, geolocation, queue, draft, behavior, direct, mail, lob, configure, receive, randomized, delay, wait, until, window, delays, blocks, false, random, split, reformat, fix, inconsistent, journey, items, holdout, decisions, examples, format, inactive, trips, rss, feed, cohort, optimize, just, words, onboarding, double, cart, abandonment, birthday, anniversary, recipe, grace, tickets, syncing, sync, stripe, follow, receiving, entering, troubleshoot, state, schedule, criteria, tags, history, teammates, parcel, stylesheet, loop, conditionals, directives, modifiable, placeholder, scratch, publish, quality, mso, emmet, fixes, cleanup, formatting, inlining, mjml, framework, transformers, responsive, dark, keyboard, convert, setting, purposes, match, building, activate, waitlist, awareness, announce, drive, usage, upsell, monetize, power, tutorials, external, merging, available, storing, profile, ids, last, field, resolve, duplicate, profiles, academy, structured, learning, demo, log, llms, txt, specifications, access, raw, specification, download, spec, render, interactive,
Text of the page (random words):
obile lifecycle events anonymous activity screen tracking track events push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages in app messages inline in app messages in app event listeners what s new 2 x 2 2 upgrade to flutter 2 x changelog flutter get started identify people track events update flutter sdk push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages in app messages in app event listeners updates and troubleshooting update ios troubleshooting changelog account workspaces account verification audit logs tasks workspace performance billing how we bill billing for sms messages billing for whatsapp messages ai credits reducing billing overages payment problems canceling your account plan features builder plan your account manage team members how to add team members assign standard roles create assign custom roles switch between accounts edit account information customize your ui manage your api credentials security best practices two factor authentication single sign on sso account regions us and eu enable experimental features workspaces workspaces in customer io understand timezone conversion case sensitivity and your data search your workspace privacy security session cookies and expiration allowlist our ip addresses customer io gdpr and you security mobile and app store privacy privacy respecting your users privacy ai settings customer io security qualifications troubleshooting troubleshooting login and browser issues create a har file for help troubleshooting ai use customer io with ai your customer io agent beta ask the agent custom skills routines segment builder troubleshooting and feedback customer io cli get started service accounts command reference customer io mcp get started chatgpt setup claude setup cursor and other ides update your mcp client email content analysis in app message suggestions in app survey analysis use our docs with ai release notes loading api documentation overview use our postman collection server addresses us and eu authentication v1 vs v2 apis rate limits open rate limits track v2 api close group make a single request http method post send multiple requests http method post track v1 overview account region open group customers open group events open group segments open group forms open group models open group powered by scalar open menu v1 0 0 openapi 3 1 0 journeys track api overview our track api provides ways to send real time customer data to your customer io workspace including customer identification and event tracking use our postman collection we ve generated a postman collection to help you get started with our apis if you fork this collection you might want to disable the watch original collection option we automatically update our postman collection whenever we release changes to our documentation even if we don t change our apis which happens daily rather than being flooded with postman notifications you can check out our release notes for updates to our apis note postman endpoints default to our us apis if you re in our european eu region you ll need to add eu to the server variables track_api_url and app_api_url server addresses us and eu customer io hosts services in the united states us and european union select the appropriate server address for your region region server address us https track customer io eu https track eu customer io note that if your account is in the eu region and you send traffic to our us endpoints we ll redirect it accordingly but this traffic still passes through us servers and data could be logged in the us authentication you can find all of your api authentication information in your account settings our tracking api uses http basic authorization the app api uses bearer authorization and you can generate tokens supporting different scopes each operation in this document references the authorization header it requires v1 vs v2 apis most of the time when we talk about the track api we re talking about the v1 api because the v2 api isn t used in any of our libraries and rarely used in libraries built by third parties it s much more common that you d encounter the v1 api if you re integrating with customer io using one of our libraries or a third party customer data platform cdp like segment or rudderstack you ll be using the v1 api the v2 api is newer and supports two important features that the v1 api doesn t natively support objects and batching but if you re integrating directly with our api we suggest you use the pipelines api the pipelines api supports both objects batching and all of our newest integrations and libraries are based on it rate limits the track api has a rate limit of 1000 requests per second for both active data integrations and historical backfill scripts this limit applies to both our v1 and v2 apis while this rate is not strictly enforced consistently exceeding it may lead to throttling or dropped data especially during periods of high system load if we detect a sustained high volume that could impact other customers we may contact you to help adjust your integration or in rare cases temporarily block requests rate limits are subject to change we may adjust these thresholds to ensure stable performance for all customers below are the payload size limits for the track api if any of these limits are too restrictive for your needs contact support to let us know your situation as we may be able to accommodate special circumstances customer limits these limits apply to people and their attributes often referred to as customers in our apis data type limit description id 150 bytes max length of a person s id value attribute name 150 bytes max length of each attribute name attribute value 1000 bytes max length of attribute values unique attributes 300 max number of attributes allowed per person or identify call object and relationship limits objects groups and relationships between people and objects can have their own attributes their limits are similar to people customers data type limit description object id 150 bytes max length of a object s id attribute names 150 bytes max length of each attribute name attribute values 1000 bytes max length of attribute values unique attributes 300 max number of attributes allowed per object or relationship total attribute size 100 kilobytes max size of all attributes associated with an object or relationship track api event limits these limits apply to events that you ll send with the v1 track call data type limit description event name 100 bytes max length of each event name event data 100000 bytes max length of each event data v2 api limits the v2 api has two endpoints both of which have limits on the total size of requests entity is limited to requests 32kb or smaller batch is limited to requests 500kb or smaller each of the requests within a batch must also be 32kb or smaller server server https track customer io the base url for the track api track endpoints use basic authentication with your site id as the user name and your secret key as the password authentication select auth type no authentication selected client libraries shell ruby node js php python more select from all clients shell curl track v2 api copy link this version of our edge api has only two endpoints but supports the majority of our traditional v1 track operations and then some based on the type and action keys that you set in your request you can use the batch call to send multiple requests at the same time unlike the v1 api you can also make requests affecting objects and deliveries objects are a grouping mechanism for people like an account people belong to or an online course that they enroll in deliveries are events based on messages sent from customer io the chart below lists the type of action you can perform for each type our requests below are broken out by type use the action dropdown to see the specific payload structure for each action action person object delivery identify delete event screen page add_relationships delete_relationships add_device delete_device merge suppress unsuppress track v2 api operations post api v2 entity post api v2 batch make a single request copy link auth required this endpoint lets you create update or delete a single person or object including managing relationships between objects and people an object is any kind of non person entity that you want to associate with one or more people like a company an educational course that people signed up for a product etc your request must be smaller than 32kb body application json one of person operations one of person identify add or update a person action discriminator enum const identify required indicates that the operation will identify the the item of the specified type values identify type enum const person required the operation modifies a person in customer io values person identifiers required the person you want to perform an action for one of either id email or cio_id you cannot pass multiple identifiers one of id show schema details timestamp type integer example 1772013598 the unix timestamp for when the attribute update occurred this can be used to control the order of attribute updates when multiple requests are sent in rapid succession attributes type object attributes that you want to add or update for this person you can pass properties that aren t defined below to set custom attributes the defined properties are reserved in the customer io track api show child attributes for attributes cio _relationships type array object object_relationships each object in the array represents a relationship you want to add to or remove from a person show child attributes for cio_relationships responses 200 a successful request returns an empty object response 400 the request was malformed or invalid application json 401 unauthorized request make sure that you provided the right credentials request example for post api v2 entity json type person identifiers id 42 action identify attributes first_name jane json copy json copy test request post api v2 entity status 200 status 400 status 401 no body a successful request returns an empty object response send multiple requests copy link auth required this endpoint lets you batch requests for different people and objects in a single request each object in your array represents an individual entity operation it represents a change for a person an object or a delivery you can mix types in this request you are not limited to a batch containing only objects or only people an object is a non person entity that you want to associate with one or more people like a company an educational course that people enroll in etc your batch request must be smaller than 500kb each of the requests within the batch must also be 32kb or smaller body application json batch copy link to batch type array a batch of requests where each object is any individual entity payload modifying a single person or object show child attributes for batch responses 200 a successful request returns an empty object response 207 at least one object in the batch was invalid all other requests are accepted this response contains a list of errors for the invalid objects in the batch application json 400 the entire request was malformed or invalid application json 401 unauthorized request make sure that you provided the right credentials request example for post api v2 batch json batch type person identifiers id 42 action identify attributes first_name jane last_name doe plan premium type object identifiers object_type_id 1 object_id acme action identify attributes name acme corp plan enterprise seats 50 type object identifiers object_type_id 1 object_id acme action add_relationships cio_relationships identifiers id 42 relationship_attributes role admin json copy json copy test request post api v2 batch status 200 status 207 status 400 status 401 no body a successful request returns an empty object response track v1 overview collapsed copy link web sdk vs backend integrations script type text javascript var _cio _cio function var a b c a function f return function _cio push f concat array prototype slice call arguments 0 b load identify sidentify track page for c 0 c b length c _cio b c a b c var t document createelement script s document getelementsbytagname script 0 t async true t id cio tracker t setattribute data site id your_site_id t setattribute data use array params true t src https assets customer io assets track js s parentnode insertbefore t s script you can integrate with this api using a javascript snippet by consuming the api directly or both you can simply copy paste the javascript snippet to your site to track basic customer behaviors directly from your website in many cases using the javascript snippet is easier to integrate with your app but there are several reasons why you may want to send events from your backend systems ad blockers are becoming more prevalent as people and browsers increasingly try to avoid 3rd party js trackers you don t plan to trigger emails based on how customers interact with your website e g users who haven t visited the site in x days you use the javascript snippet but have a few events you d like to send from your backend system they will work well together you would rather not have another javascript snippet slowing down your frontend our snippet is asynchronous doesn t affect initial page load and very small but we understand you should base your decision to send events from your backend or a javascript snippet on what works best for you you can fully integrate with customer io using either approach account region collapsed copy link determine whether your account and data are hosted in the us or eu data center using your track api key account region operations get api v1 accounts region show more customers collapsed copy link add modify suppress or unsuppress people referred to as customers in our apis you can also use these endpoints to set attributes on people customers operations put api v1 customers identifier delete api v1 customers identifier put api v1 customers identifier devices delete api v1 customers identifier devices device_id post api v1 customers identifier suppress post api v1 customers identifier unsuppress post unsubscribe delivery_id post api v1 merge_customers show more events collapsed copy link use customer events to trigger campaigns or add users to segments you can attribute events directly to customers or send anonymous events and associate them with users later when you identify them events operations post api v1 customers identifier events post api v1 events post api v1 metrics post api v1 push events show more segments collapsed copy link manual segments are lists of people that you incorporate using the api or by uploading csvs you can add people to or remove people from manual segment...
|
