openapi: 3.0.3
info:
title: BlueConic REST API v2 Audit Events Plugins API
description: "Welcome to the [BlueConic](https://www.blueconic.com) REST API v2. Our recently updated APIs offer access to a wealth of resources to interact with BlueConic visitor profiles, segments, interactions, and audit events via OpenAPI and OAuth 2.0 authorization flows making the interconnection between various services more secure, intuitive, and reliable than ever before.\n\nThis page describes how developers can use OAuth 2.0, the industry-standard protocol for authorization, to authorize apps in BlueConic and get started using the BlueConic REST API v2.\n\nLearn more about [how to use the BlueConic REST API v2](https://support.blueconic.com/hc/en-us/articles/200453891-Using-the-BlueConic-REST-API).\n\n# Authorizing an application to use the BlueConic REST API via OAuth 2.0\n\nIf you have an external software application that needs to communicate with BlueConic, you need to allow access to the BlueConic REST API. The authorization process in BlueConic for this access is built to OAuth 2.0 specifications. You can use either of two authorization flows: the authorization code flow and the client credentials flow. The most secure flow is the authorization code flow, intended for use with a user who can log in to BlueConic and authenticate the application to use the BlueConic API. The client credentials flow is easier to implement but lacks security features present in the authorization code flow. The client credentials flow is intended for machine-to-machine applications. \n\n## Using the Authorization code flow\n\nTo use the BlueConic REST API with OAuth 2.0 according to the authorization code flow you need to complete the following steps:\n\n1. Configure BlueConic so your external OAuth 2.0 application can authenticate and use the REST API. This means that you have to:\n - Have a BlueConic user with the \"Applications\" permission. This user can configure the details of the external application in BlueConic.\n - Have a BlueConic user with the \"Authorize Applications\" permission. This user can authorize the external application via the redirect page served by the authorization server.\n - Configure the external application on the BlueConic Access management > Applications tab, so BlueConic can store public client ID and the client secret. The external app uses these properties to perform the initial request for an authorization code.\n\n\n2. Develop an application that can execute OAuth 2.0 REST API requests. Specifically, that means an application that is able to:\n - Generate a code verifier and code challenge.\n - Store the public client ID and client secret as configured in BlueConic (see step 1). \n - Request an authorization code from the BlueConic authorization server. Include the code challenge in the request. \n - Show the user the redirect page served by the BlueConic authorization server, so the user can authenticate with credentials and consent to giving the application BlueConic REST API access.\n - Receive the authorization code from the BlueConic authorization server.\n - Use the authorization code to request an access token (and refresh token) from the BlueConic authorization server. Include the code verifier in the request. You must also provide the client ID and client secret for client authentication. You can do so by sending the client credentials in the body of your POST request.\n - Use the access token to perform REST API requests. \n - Revoke access if the user of the app so chooses (meaning that after this revocation, a new authorization grant is required to use the BlueConic REST API).\n - Handle refresh token rotation. This means that whenever a new access token is requested using the refresh token, a new refresh token is also supplied along with the new access token.\n - Handle all possible responses from the BlueConic REST API appropriately.\n\n[Read more about the Authorization Code Flow](https://support.blueconic.com/hc/en-us/articles/14912561861403)\n\n## Using the Client credentials flow\n\nTo make use of the BlueConic REST API with OAuth 2.0 following the client credentials flow, you need to complete the following steps:\n\n1. Configure BlueConic so your external OAuth 2.0 application can use the REST API. This means that you have to:\n - Have a user with the \"Applications\" permission. This user can configure the details of the external application in BlueConic.\n - Have a user with the \"Authorize Applications\" permission, who also has all permissions needed to use the REST API endpoint that you intend to use.\n - Configure the external application on the Access management > Applications tab, so BlueConic can generate and store the public client ID and client secret for client authentication. Also select at least one scope so the app has access to that part of the REST API.\n \n2. Develop an application that can execute OAuth 2.0 REST API requests. Specifically that means an application that is able to:\n - Store the public client ID and client secret as configured in BlueConic (see above).\n - Use the client ID and client secret to request an access token from the BlueConic authorization server. You can do so by sending the client credentials in the body of your POST request.\n - Use the access token to perform REST API requests.\n - Handle all possible responses from the BlueConic REST API appropriately.\n\n[Read more about the Client Credentials Flow](https://support.blueconic.com/hc/en-us/articles/14912655111963)\n\n# Using the try-out feature\nThe “Try” feature allows you to directly make REST calls to the API server, where you can make requests and see the responses, allowing you to experiment with the BlueConic API and understand how it works.\n\nYou can enter your BlueConic URL in the “API Servers” section. After that, you can try out the calls that don’t require authentication, such as “Get interactions”. You can enter the request parameters and click “Try”.\n\n## OAuth 2.0 authentication\n\nMost calls require OAuth 2.0 authentication, such as “Get audit events”. This can be seen at the right top and under the Request heading of each API method. To use the “Try” feature, you need to authenticate via OAuth 2.0. First create an Application in your BlueConic tenant (see above). When using the Authorization code flow, make sure to set the redirect URL to this tool as specified under the OAuth 2.0 authentication section. After you create the Application, authenticate this tool in the “Authentication” section. Enter the client ID and client secret in the correct OAuth 2.0 flow for which you created the application and press “GET TOKEN”. If the tool got a token successfully, you will see the text “API key applied” just under the “Authentication” heading. In calls that require Authentication, it will say “OAuth (OAuth 2.0) in header”. Now you can use the “Try” feature for calls that require OAuth 2.0. If you hover over the authentication scheme at the top right of an API method, you will see the required scopes (e.g. “Get audit events” has the scope read:audit-events). Make sure you set these scopes for the Application in BlueConic.\n\n# General functionality for all endpoints\n\n1. By using `prettyPrint`, the JSON data is formatted in a way that makes it easier to read and work with. This can be especially useful when working with large or complex JSON datasets. Add the following to the query string of a request to pretty print JSON: `&prettyPrint=true`.\n2. Gzip encoding is a method of compressing data and is commonly used to reduce the size of files sent over the Internet. BlueConic supports this so a client can set the request header `Accept-Encoding: gzip`. BlueConic will then compress the data in its response and send it back to the client with the `Content-Encoding: gzip` header. \n\n"
termsOfService: https://www.blueconic.com/blueconic-terms-and-conditions
contact:
name: Contact us
url: https://support.blueconic.com/hc/en-us/requests/new
license:
name: BlueConic
url: https://github.com/blueconic/openapi/blob/main/LICENSE.MD
version: '100.0'
servers:
- url: https://{blueconicHostname}/rest/v2
description: The BlueConic server
variables:
blueconicHostname:
description: BlueConic server hostname, e.g. 'tenant.blueconic.net'
default: tenantname
tags:
- name: Plugins
description: 'Retrieve plugins from the gallery, or limit results to installed plugins only. See [Plugins](https://support.blueconic.com/en/articles/248049-plugins-overview). '
paths:
/plugins/{plugin}:
get:
tags:
- Plugins
summary: Get one plugin
description: Retrieves a single plugin
operationId: getOnePlugin
parameters:
- name: plugin
in: path
required: true
schema:
type: string
responses:
'200':
description: Returns the plugins.
content:
application/json:
schema:
$ref: '#/components/schemas/plugin'
examples:
Response body:
description: Response body
value: "{\n \"URL\": \"http://plugins.blueconic.net/connection_facebook_ads/5.5.0/connection_facebook_ads.xml\",\n \"channelTypes\": [\n \"WEBSITE\"\n ],\n \"creationDate\": \"2025-09-30T13:51:12.555Z\",\n \"description\": \"\",\n \"descriptions\": [\n {\n \"key\": \"en_US\",\n \"value\": \"\\\\nSend data from BlueConic to Facebook Advertising to enrich Facebook profiles or to target audiences on Facebook and Instagram. Supports conversion API, pixel implementation, and custom audience sync.<br /> Make sure you have no active ad blocker when configuring this connection.<br /> <a href=\\\\\"https://support.blueconic.com/hc/en-us/articles/205377811-Facebook-Advertising-Connection?utm_source=BlueConic_User\\\\\" target=\\\\\"_blank\\\\\">Read more</a> \"\n }\n ],\n \"id\": \"connection_facebook_ads\",\n \"indexURL\": \"http://plugins.blueconic.net/connection_facebook_ads/index.xml\",\n \"labels\": [\n {\n \"key\": \"en_US\",\n \"value\": \"Facebook Advertising connection\"\n }\n ],\n \"lastModifiedDate\": \"2025-09-30T13:51:12.555Z\",\n \"latestVersion\": true,\n \"name\": \"connection_facebook_ads\",\n \"positionType\": \"\",\n \"profileIndependent\": false,\n \"scheduleMode\": \"SCHEDULED\",\n \"supportLevel\": \"STANDARD\",\n \"tags\": [],\n \"type\": \"batchconnection\",\n \"version\": \"5.5.0\"\n}"
'401':
description: Authentication failed (unauthorized).
'403':
description: Authorization failed (incorrect permissions).
'404':
description: The plugin doesn't exist.
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- read:plugins
/plugins:
get:
tags:
- Plugins
summary: Get all plugins
description: Retrieves all plugins.
operationId: getAllPlugins
parameters:
- name: startIndex
in: query
description: Specifies the index of the first item to include in the result.
schema:
type: integer
format: int64
default: 0
example: 0
- name: count
in: query
description: Specifies the number of results to return.
schema:
type: integer
format: int64
default: 20
example: 10
- name: filterType
in: query
schema:
type: string
- name: onlyWithPermission
in: query
description: If true, only plugins that you have all permissions for are returned.
schema:
type: boolean
- name: includeGallery
in: query
description: If true, plugins from the gallery that are not installed are returned.
schema:
type: boolean
- name: locale
in: query
description: Locale used for labels and descriptions.
schema:
type: string
- name: channelTypes
in: query
description: Only show plugins that have a matching channel type (one or more).
schema:
type: string
enum:
- WEBSITE
- EMAIL
- MOBILE
- CTV
responses:
'200':
description: Returns the plugins.
content:
application/json:
schema:
$ref: '#/components/schemas/plugin'
examples:
Response body:
description: Response body
value: "{\n \"itemsPerPage\": 4,\n \"plugins\": [\n {\n \"URL\": \"http://plugins.blueconic.net/analyzer_blueconic/1.0.0/analyzer_blueconic.xml\",\n \"channelTypes\": [],\n \"creationDate\": \"2025-09-30T13:50:54.986Z\",\n \"description\": \"\",\n \"descriptions\": [],\n \"id\": \"analyzer_blueconic\",\n \"indexURL\": \"http://plugins.blueconic.net/analyzer_blueconic/index.xml\",\n \"labels\": [\n {\n \"key\": \"en_US\",\n \"value\": \"Site Analyzer for BlueConic\"\n },\n {\n \"key\": \"nl_NL\",\n \"value\": \"Site Analyzer for BlueConic\"\n }\n ],\n \"lastModifiedDate\": \"2025-09-30T13:50:54.986Z\",\n \"latestVersion\": true,\n \"name\": \"analyzer_blueconic\",\n \"positionType\": \"\",\n \"profileIndependent\": false,\n \"supportLevel\": \"STANDARD\",\n \"tags\": [],\n \"type\": \"globallistener\",\n \"version\": \"1.0.0\"\n },\n {\n \"URL\": \"http://plugins.blueconic.net/connection/1.0.0/connection.xml\",\n \"channelTypes\": [],\n \"creationDate\": \"2025-09-30T13:50:36.248Z\",\n \"description\": \"\",\n \"descriptions\": [],\n \"id\": \"connection\",\n \"indexURL\": \"http://plugins.blueconic.net/connection/index.xml\",\n \"labels\": [],\n \"lastModifiedDate\": \"2025-09-30T13:50:36.248Z\",\n \"latestVersion\": true,\n \"name\": \"connection\",\n \"supportLevel\": \"STANDARD\",\n \"tags\": [],\n \"type\": \"parameter\",\n \"version\": \"1.0.0\"\n },\n {\n \"URL\": \"http://plugins.blueconic.net/connection_facebook_ads/5.5.0/connection_facebook_ads.xml\",\n \"channelTypes\": [\n \"WEBSITE\"\n ],\n \"creationDate\": \"2025-09-30T13:51:12.555Z\",\n \"description\": \"\",\n \"descriptions\": [\n {\n \"key\": \"en_US\",\n \"value\": \"\\\\nSend data from BlueConic to Facebook Advertising to enrich Facebook profiles or to target audiences on Facebook and Instagram. Supports conversion API, pixel implementation, and custom audience sync.<br /> Make sure you have no active ad blocker when configuring this connection.<br /> <a href=\\\\\"https://support.blueconic.com/hc/en-us/articles/205377811-Facebook-Advertising-Connection?utm_source=BlueConic_User\\\\\" target=\\\\\"_blank\\\\\">Read more</a> \"\n }\n ],\n \"id\": \"connection_facebook_ads\",\n \"indexURL\": \"http://plugins.blueconic.net/connection_facebook_ads/index.xml\",\n \"labels\": [\n {\n \"key\": \"en_US\",\n \"value\": \"Facebook Advertising connection\"\n }\n ],\n \"lastModifiedDate\": \"2025-09-30T13:51:12.555Z\",\n \"latestVersion\": true,\n \"name\": \"connection_facebook_ads\",\n \"positionType\": \"\",\n \"profileIndependent\": false,\n \"scheduleMode\": \"SCHEDULED\",\n \"supportLevel\": \"STANDARD\",\n \"tags\": [],\n \"type\": \"batchconnection\",\n \"version\": \"5.5.0\"\n },\n {\n \"URL\": \"http://plugins.blueconic.net/contentinteractiontype/1.4.0/contentinteractiontype.xml\",\n \"channelTypes\": [\n \"WEBSITE\"\n ],\n \"creationDate\": \"2025-09-30T13:50:37.680Z\",\n \"description\": \"\",\n \"descriptions\": [\n {\n \"key\": \"en_US\",\n \"value\": \"\\\\n \\\\n A 'Content' interaction allows you to replace content on a web-based channel. <a href=\\\\\"https://support.blueconic.com/hc/en-us/articles/202421572-Content-Action-?utm_source=BlueConic_User\\\\\" target=\\\\\"_blank\\\\\">Read more</a>\\\\n \\\\n \"\n }\n ],\n \"id\": \"contentinteractiontype\",\n \"indexURL\": \"http://plugins.blueconic.net/contentinteractiontype/index.xml\",\n \"labels\": [\n {\n \"key\": \"en_US\",\n \"value\": \"Content\"\n }\n ],\n \"lastModifiedDate\": \"2025-09-30T13:50:37.680Z\",\n \"latestVersion\": true,\n \"name\": \"contentinteractiontype\",\n \"positionType\": \"position\",\n \"profileIndependent\": false,\n \"supportLevel\": \"STANDARD\",\n \"tags\": [],\n \"type\": \"action\",\n \"version\": \"1.4.0\"\n }\n ],\n \"startIndex\": 0,\n \"totalPages\": 20,\n \"totalResults\": 98\n}"
'401':
description: Authentication failed (unauthorized).
'403':
description: Authorization failed (incorrect permissions).
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- read:plugins
components:
schemas:
UserBean:
type: object
description: BlueConic user.
properties:
fullName:
type: string
description: The full name of the user.
userName:
type: string
description: The username.
readOnly: true
plugin:
type: object
properties:
URL:
type: string
description: The URL of the plugin.
channelTypes:
type: array
items:
type: string
enum:
- WEBSITE
- FACEBOOK
- EMAIL
- MOBILE
- CTV
creationDate:
type: string
format: date-time
description: The creation date of the plugin. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
creator:
$ref: '#/components/schemas/UserBean'
description:
type: string
description: The description of the plugin.
descriptions:
type: array
description: 'Localized description text displayed in the About section of the plugin. Provides a brief summary of the plugin’s purpose or functionality. Note: the UI always displays the description with the key set to en_US.'
items:
$ref: '#/components/schemas/DescriptionLabel'
uniqueItems: true
id:
type: string
description: The ID of the plugin.
indexURL:
type: string
description: The index url of the plugin.
labels:
type: array
description: 'Localized display name of the plugin. Note: the UI always displays the description with the key set to en_US.'
items:
$ref: '#/components/schemas/Label'
uniqueItems: true
lastModifiedDate:
type: string
format: date-time
description: The last modified date of the plugin. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
lastModifiedUser:
$ref: '#/components/schemas/UserBean'
latestVersion:
type: boolean
description: Whether this is the latest version of the plugin.
name:
type: string
description: The name of the plugin.
scheduleMode:
type: string
enum:
- SCHEDULED
- CONTINUOUS
supportLevel:
type: string
description: The support level of the plugin.
type:
type: string
description: The type of the plugin.
version:
type: string
description: The version of the plugin.
DescriptionLabel:
type: object
description: 'Localized description text displayed in the About section of the plugin. Provides a brief summary of the plugin’s purpose or functionality. Note: the UI always displays the description with the key set to en_US.'
properties:
key:
type: string
description: Language code that specifies the locale of the description text. Follows the IETF BCP 47 format (e.g., en_US for U.S. English)
value:
type: string
description: The localized description text for the specified language.
Label:
type: object
description: 'Localized display name of the plugin. Note: the UI always displays the description with the key set to en_US.'
properties:
key:
type: string
description: Language code that specifies the locale of the labels text. Follows the IETF BCP 47 format (e.g., en_US for U.S. English)
value:
type: string
description: The localized display name for the specified language.
securitySchemes:
oauth2:
type: oauth2
description: 'Authenticates a registered OAuth 2.0 client. The Authorization code flow and Client credentials flow are supported. Make sure to select the correct flow based on which flow the registered client supports. The client id and client secret can be found in BlueConic by opening the registered client under *Settings* > *Access management* > *Applications*.<br/>**NOTE:** When using the Authorization code flow, the redirect URL of the registered client in BlueConic must be set to `https://rest.apidoc.blueconic.com/oauth-receiver.html` and ''Send Proof Key for Code Exchange'' must be enabled.<br/><br/>To use a Bearer token for authentication, follow these steps: <br/>1. Acquire the token through authentication.<br/>2. Include the token in the request''s Authorization header as Bearer \<token\>.<br/>3. Send the request to access protected resources.<br/>4. Handle token expiration by refreshing or obtaining a new token.'
flows:
clientCredentials:
tokenUrl: /rest/v2/oauth/token
authorizationCode:
authorizationUrl: /rest/v2/oauth/authorize
tokenUrl: /rest/v2/oauth/token
refreshUrl: /rest/v2/oauth/token