# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
method: generated
id: blueconic-vocabulary
name: BlueConic API Vocabulary
description: Domain vocabulary for the BlueConic Customer Data Platform REST API v2, covering profiles, segments, connections,
lifecycle stages, and data activation concepts.
version: 1.0.0
provider: BlueConic
url: https://support.blueconic.com/en/articles/248008-overview-blueconic-rest-api
terms:
- term: Visitor Profile
type: entity
description: A unified record of a single customer or visitor containing all behavioral, demographic, and interaction data
collected by BlueConic.
- term: Segment
type: entity
description: A dynamic or static grouping of visitor profiles based on defined criteria such as behavior, demographics,
or lifecycle stage.
- term: Lifecycle Stage
type: entity
description: A defined phase in the customer journey used to categorize and advance visitor profiles through marketing or
engagement funnels.
- term: Connection
type: entity
description: An integration with an external platform or service that imports or exports data to/from BlueConic visitor
profiles.
- term: Dialogue
type: entity
description: A personalization campaign or content experience delivered to visitors based on segment membership and rules.
- term: Listener
type: entity
description: A tracking configuration that captures visitor events such as page views, clicks, or form submissions.
- term: Profile Property
type: entity
description: A named data attribute stored on a visitor profile, such as email address, age, or custom behavioral metric.
- term: Interaction
type: entity
description: A recorded engagement event between a visitor and BlueConic-powered content or personalization.
- term: Timeline Event
type: entity
description: A time-stamped event in a visitor profile history used for journey analysis and behavioral targeting.
- term: Recommendation
type: entity
description: A content or product suggestion generated by BlueConic machine learning models based on visitor profile data.
- term: Group
type: entity
description: A collection of visitor profiles organized by a shared group type for targeting or reporting purposes.
- term: Objective
type: entity
description: A measurable business goal tracked against visitor behavior within BlueConic.
- term: Notebook
type: entity
description: A BlueConic analytical workbook that runs data science and segmentation scripts against profile data.
- term: Audit Event
type: entity
description: A log entry capturing administrative or API actions taken within a BlueConic tenant for compliance and security.
- term: Content Store
type: entity
description: A repository of structured content items within BlueConic used for recommendation and personalization delivery.
- term: OAuth 2.0
type: concept
description: The authorization protocol used by the BlueConic REST API, supporting both authorization code flow and client
credentials flow.
- term: Client Credentials Flow
type: concept
description: Machine-to-machine OAuth 2.0 authorization using a client ID and secret without user interaction.
- term: Authorization Code Flow
type: concept
description: User-delegated OAuth 2.0 authorization requiring user login and consent to grant API access.
- term: Tenant
type: concept
description: A BlueConic customer environment identified by a subdomain (tenantname.blueconic.net) that hosts all customer
data and configurations.
- term: First-Party Data
type: concept
description: Customer data collected directly from visitor interactions, stored in BlueConic profiles without third-party
intermediaries.
- term: CDP
type: concept
description: Customer Data Platform — the category of software BlueConic represents, unifying customer data for activation.
- term: Data Activation
type: concept
description: The process of using unified profile data to personalize experiences and trigger downstream actions in connected
systems.
- term: Audit Events
type: resource-category
description: "The Audit Event API allows users to connect BlueConic to a SIEM system. We recommend using this API to periodically\
\ receive security-related activities based on a rolling window. The API has a 30-day retention period.\n\nThe API logs\
\ the following audit events:\n\n| Object | Events \
\ |\n|:---------------------------|:-----------------------------------------------------------------------------------------------|\n\
| BlueConic hostname | Create, Update, Delete \
\ |\n| BlueConic Support Access | Update (for each change) \
\ |\n| Channel | Create, Update, Delete \
\ |\n| Clean up rule | Create, Update, Delete \
\ |\n| Connection | Create, Update, Delete, Manual run,\
\ Scheduled run |\n| Dashboard | Create, Update, Delete\
\ |\n| Dialogue | Create, Update,\
\ Delete |\n| Domain Group | Create,\
\ Update, Delete |\n| Gen AI Setting \
\ | Update (for each change) |\n| Group \
\ | Read, Update, Delete |\n\
| Group type | Create, Update, Delete \
\ |\n| Ip range | Create, Update, Delete \
\ |\n| Language | Create, Update, Delete \
\ |\n| Lifecycle | Create, Update, Delete \
\ |\n| Merge rule | Create, Update, Delete \
\ |\n| Models | Create, Update, Delete\
\ |\n| Notebook | Create, Update,\
\ Delete, Manual run, Scheduled run, Editor run |\n| OAuth application | Create,\
\ Update, Delete |\n| OAuth token \
\ | Create, Update, Delete |\n| Objective \
\ | Create, Update, Delete |\n\
| Plugin | Create, Update, Delete \
\ |\n| Privacy setting | Update (for each change) \
\ |\n| Profile | Read, Update, Delete \
\ |\n| Profile property | Create, Update, Delete \
\ |\n| Role | Create, Update, Delete \
\ |\n| Segment | Create, Update, Delete\
\ |\n| Single Sign On Setting | Update (for\
\ each change) |\n| Inactvity Setting |\
\ Update (for each change) |\n| Supported Legislation\
\ Zone | Create, Delete, Update |\n| Timeline\
\ Event Rollup | Create, Update, Delete |\n\
| Timeline Event Type | Create, Update, Delete \
\ |\n| Tracker | Create, Update, Delete \
\ |\n| User | Login, Login failed, Logout, Create, Update, Delete, Password\
\ reset requested, Password change |\n\n\nOnly Profile and Group viewed, updated, or deleted by a user from the Profile\
\ and Groups tab are logged.\n\nThe following events are not considered as human actions, and therefore not covered in\
\ the Platform\nAudit Event API:\n\n- Connections that import or export profiles.\n- Profile and group creation (Profiles\
\ can only be created by a visitor or an import connection).\n\n**Event data**\n\nThe following event data is available:\n\
\n| Field | Description | Example values \
\ \
\ \
\ \
\ \
\ |\n| :--- | :--- |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\
|date|Datetime in UTC when the event occurred. The date is in the https://www.ietf.org/rfc/rfc3339.txt format.| 2025-04-15T11:24:01.183Z\
\ \
\ \
\ \
\ \
\ |\n|username|(BlueConic) Identifier (email address) of\
\ the user who did the action.
Value is empty for failed login attempts.| test@blueconic.com \
\ \
\ \
\ \
\ \
\ |\n|objectType|Object of the action.|
Human readable name of the object.
For\ \ Profiles, the name is determined by the first value that is not empty:
For Users, the name is determined by the first value that is not empty:
For groups, the name is\ \ the group id.
For PRIVACY_SETTING and SINGLE_SIGN_ON_SETTING, the objectName is the name(s) of the changed\ \ setting. E.g. Status, Identity_Provider_Issuer_URL_Entity_ID.
For BLUECONIC_SUPPORT_ACCESS_SETTING the\ \ objectName contains the new settings.
`\"objects\" : [ {\"name\" : \"No Access\", \"id\" : \"none\" }\ \ ]` or
`\"objects\" : [ {\"name\" : \"User name here\", \"id\" : \"user1@blueconic.com\" },{\"name\"\ \ : \"User name 2 here\", \"id\" : \"user2@blueconic.com\" }],` (contains the new list) or
`\"objects\"\ \ : [ {\"name\" : \"All BlueConic support employees\", \"id\" : \"all\" } ],`