Skip to content

Tracardi Documentation

API

Initializing search

tracardi/tracardi-api

Tracardi Documentation

tracardi/tracardi-api

Tracardi Customer Data Platform
What is Tracardi
Getting started
Getting started
Installation
Installation
- Tracardi Installation
- Dependencies
  Dependencies
  - Installing Tracardi Dependencies
- Open Source
  Open Source
  - Open-Source Installation
- Commercial
  Commercial
  - Commercial Installation
- Development
  Development
  - Development Environment Installation Guide
- Production
  Production
- Upgrades
  Upgrades
  - Tracardi Upgrades
Configuration
Configuration
- Tracardi configuration
- Configuration best practises
- Elasticsearch
  Elasticsearch
- Staging server
  Staging server
  - Staging server
- SSL Configuration
Integration
Integration
- API
  API
- Javascript
  Javascript
- Redirected Links
  Redirected Links
  - Link tracking, redirects
- Passing Profile ID in link
  Passing Profile ID in link
  - Forcing profile ID on the page
Traffic
Traffic
- Inbound traffic
- Bridges
  Bridges
- Outbound traffic
Events
Events
- Event's Core Definitions
- Event Fields
- Customer tracking
- Event tracking
- Event validation
- Profile Synchronization in Data Management
- Event traits schema
  Event traits schema
  - Event traits schema
- Internal event types
  Internal event types
  - Pre-build event types
Sessions
Sessions
- Session
Profiles
Profiles
Resources
Resources
- Resources
- Documentation
  Documentation
Workflows
Workflows
- Workflow Core Definitions
- Actions
  Actions
  - Action's Core Definitions
  - IF Action
  - Elastic email contact action
  - Send transactional e-mail plugin
  - Detect client agent action
  - Inject values
  - Event scheduler
  - Get previous event plugin
  - Get Previous Session
  - New Event Action
  - New visit
  - Event counter
  - Resolve conditions
  - Count records by query string plugin
  - Create payload action
  - Template Plugin
  - Append/Remove data plugin
  - Start plugin
  - Decode Base64
  - Encode Base64
  - Data check action
  - Load profile by ...
  - Sort array action
  - Sort dictionary
  - Join string list
  - String similarity
  - Send Twitter tweet plugin
  - GeoIp service
  - Send SMS with Sms77 gateway
  - Calculator
  - Return random item
  - Assign condition results plugin
  - Reduce array plugin
  - Password generator
  - Contains Pattern Plugin
  - Google translate plugin
  - Join
  - Limiter plugin
  - Merge data
  - Add Empty Profile
  - Add Empty Session
  - Add Interest
  - ClickSend Send SMS
  - Copy data
  - Cut out data
  - Data to JSON
  - Decrease Interest
  - Delete data
  - End
  - Geo distance
  - Get Event Source Plugin
  - Get Issue
  - Google Spreadsheet
  - Has Segment
  - Hash data
  - HTML fetcher
  - Increase Interest
  - Inject Event
  - JSON to data
  - Last Profile Visit Time
  - List Issues
  - Mask data
  - Merge event properties
  - Microservice
  - Profile live time
  - Query Local Database
  - Show consent bar
  - Sleep
  - String splitter
  - String to Date
  - Tag Event
  - Time Difference
  - Update Event Action
  - UUID4
  - Whois Plugin
  - XPATH HTML Scrapper
  - Circular Geo Fence
  - Find Max Value
  - Set Operation Plugin
  - String Replace
  - Save Integration Id
  - Assign profile id plugin
  - Load Integration Id
  - Ghost
  - Group and Rank Interests
  - S3 Segments Uploader Plugin
  - Force segmentation
  - Has segment
  - Commercial
    Commercial
    
    Pause and resume
    
    Run In Background
    
    ChatGPT prompt
    
    Event Aggregator
    
    Event Counter
    
    Generic UIX Plugin
    
    Limiter
    
    Load report data
    
    OpenReplay UX
    
    Pause and Resume
    
    Sequencer Matcher
    
    Event Sequence
    
    Send SMS
    
    Delete vector
    
    Vector exists
    
    Load vector
    
    Store vector
    
    YouTube widget
  - Segmentaion
    Segmentaion
    
    Add segment
    
    Delete segment
    
    Move segment
    
    Profile segmentation
  - Operations
    Operations
    
    Update Event Action
    
    Merge profiles
    
    New profile
    
    Update Session Action
  - Stats
    Stats
    
    Increment action
    
    Decrement action
    
    Key counter
  - Connectors
    Connectors
    
    Zapier webhook
    
    E-mail via SMTP
    
    Remote call plugin
    
    Full contact webhook
    
    RabbitMQ publisher
    
    Pushover push
    
    Weather plugin
    
    Get OAuth2 token plugin
    
    Send to InfluxDB plugin
    
    RabbitMQ publisher
    
    Fetch data from Airtable plugin
    
    Fetch from InfluxDB plugin
    
    Elasticsearch query plugin
    
    Password generator
    
    ContainsString Plugin
    
    EndsWith Plugin
    
    StartsWith Plugin
    
    Weekdays checker plugin
    
    Databases
    Databases
    
    Mongo connector
    
    Mysql Connector
    
    Send data to Airtable plugin
    
    Messagers
    Messagers
    
    Post to Slack channel plugin
    
    Discord webhook plugin
    
    Telegram post plugin
    
    Novu
    Novu
    
    Novu trigger plugin
    
    Elastic mail
    Elastic mail
    
    Send bulk e-mail plugin
    
    Add contact to Elastic Email plugin
    
    Add contact to Elastic Email plugin
    
    Trello
    Trello
    
    Add Trello card plugin
    
    Add Trello member plugin
    
    Remove Trello card plugin
    
    Move Trello card plugin
    
    Mautic
    Mautic
    
    Add contact to Mautic plugin
    
    Fetch Mautic contact by email plugin
    
    Fetch Mautic contact by ID plugin
    
    Edit points in Mautic plugin
    
    Edit segment in Mautic plugin
    
    Mixpanel
    Mixpanel
    
    Fetch funnel from MixPanel plugin
    
    Send to MixPanel plugin
    
    Mailchimp
    Mailchimp
    
    Send transactional e-mail plugin
    
    Add to MailChimp audience plugin
    
    Remove from MailChimp audience plugin
    
    Sales force
    Sales force
    
    Salesforce Data Extension plugin
    
    Active campaign
    Active campaign
    
    Fetch contact from ActiveCampaign plugin
    
    Add contact to ActiveCampaign action
    
    Hubspot
    Hubspot
    
    Get company from HubSpot plugin
    
    Get contact from HubSpot plugin
    
    Update company from HubSpot plugin
    
    Plugin documentation
    
    Plugin documentation
    
    Update contact from HubSpot plugin
    
    Sendgrid
    Sendgrid
    
    Send bulk e-mail plugin
    
    Add contact to Sendgrid plugin
    
    Send bulk e-mail plugin
    
    Google
    Google
    
    Google Analytics Event Tracker
    
    Google analytics 4 event tracker
    
    Matomo
    Matomo
    
    Matomo register event
  - Regex
    Regex
    
    String Validator
    
    Regex Match
    
    Regex string replace plugin
  - Locations
    Locations
    
    GeoLite2 Plugin
  - Time
    Time
    
    Day/Night
    
    Local time span action
    
    Calculate Time Difference Plugin
    
    Today
    
    Time Delay
  - Processing
    Processing
    
    Parse URL
    
    String splitter
    
    String properties and transformations
    
    Value mapping plugin
  - Validators
    Validators
    
    Validate with JSON schema plugin
    
    String Validator Action
    
    Get field type plugin
  - Machine Learning
    Machine Learning
    
    Text Classification
    
    Language detection Plugin
    
    Sentiment analysis action
    
    Corporate reputation plugin
    
    Categorize text plugin
    
    Summarize text plugin
    
    Extract topics plugin
  - UX
    UX
    
    Show question popup plugin
    
    Rating Popup Plugin
    
    Show contact popup plugin
    
    Chat
    Chat
    
    Chatwoot widget
    
    Intercom widget
    
    LiveChat widget
    
    Zendesk widget
  - Memory
    Memory
    
    Write to memory plugin
    
    Read from memory plugin
    
    Memory payload collector
  - Consents
    Consents
    
    Add consent plugin
    
    Has consents
  - Errors
    Errors
    
    Log message plugin
    
    Throw error plugin
Filtering
Filtering
- Data searching - prior version 0.8.2
Notations
Notations
Q&A
Q&A
API
Developers
Developers
- Development environment set-up
  Development environment set-up
  - ReactJs development environment
  - Python development environment
- Mirco frontend apps development
  Mirco frontend apps development
  - Micro frontend applications
- Plugins
  Plugins
- Destinations
  Destinations
  - How to Add a New Destination Type in Tracardi
- Resources
  Resources
  - How to Add a Resource to Tracardi
Error descriptions
Error descriptions
License
License
Running Tracardi GUI
Troubleshooting
Support us
Documentation license

API

Tracardi is an API-first platform, please visit http://127.0.0.1/docs to see the API documetnation.

Copyright © 2020 - 2021 Tracardi

Made with Material for MkDocs