openapi: 3.0.3 info: title: BlueConic REST API v2 Audit Events Notebooks 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: Notebooks description: The following methods allow you to retrieve AI Workbench notebooks and their run history. See [AI Workbench Overview](https://support.blueconic.com/en/articles/247838-ai-workbench-overview). paths: /notebooks: get: tags: - Notebooks summary: Get all notebooks description: Retrieves all notebooks. operationId: getAllNotebooks 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 responses: '200': description: Returns the notebooks. content: application/json: schema: $ref: '#/components/schemas/notebooks' examples: Response body: description: Response body value: "{\n \"itemsPerPage\": 10,\n \"notebooks\": [\n {\n \"creationDate\": \"2025-09-23T07:39:27.040Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"description\": \"\",\n \"id\": \"f72deceb-c261-48ee-a355-56de0d37be92\",\n \"lastModifiedDate\": \"2025-09-24T07:23:55.044Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"lastRun\": {\n \"endDate\": \"2025-09-23T07:43:34.567Z\",\n \"goalStatistics\": [],\n \"message\": \"

Notebook execution finished. Preview, JSON, log

\",\n \"runCount\": 2,\n \"runId\": \"20250923074329_f72deceb-c261-48ee-a355-56de0d37be92\",\n \"startDate\": \"2025-09-23T07:43:29.564Z\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"notebook1\",\n \"pluginId\": \"notebook_blank\",\n \"isEnabled\": false,\n \"tags\": []\n },\n {\n \"creationDate\": \"2025-09-24T07:24:00.877Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"description\": \"\",\n \"id\": \"072bc703-1958-423c-9def-10864ab08e73\",\n \"lastModifiedDate\": \"2025-09-24T07:24:00.877Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"name\": \"notebook2\",\n \"pluginId\": \"notebook_blank\",\n \"isEnabled\": true,\n \"tags\": []\n }\n ],\n \"startIndex\": 0,\n \"totalPages\": 1,\n \"totalResults\": 2\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:notebooks /notebooks/{notebook}: get: tags: - Notebooks summary: Get one notebook description: Retrieves a single notebook. operationId: getOneNotebook parameters: - name: notebook in: path description: The ID of the notebook. required: true schema: type: string examples: UUID of the notebook: description: UUID of the notebook value: ce016360-28ae-4e05-952a-cb5f642cd2b7 responses: '200': description: Returns the notebook. content: application/json: schema: $ref: '#/components/schemas/notebook' examples: Response body: description: Response body value: "{\n \"creationDate\": \"2025-09-23T07:39:27.040Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"description\": \"\",\n \"id\": \"f72deceb-c261-48ee-a355-56de0d37be92\",\n \"lastModifiedDate\": \"2025-09-24T07:23:55.044Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"lastRun\": {\n \"endDate\": \"2025-09-23T07:43:34.567Z\",\n \"goalStatistics\": [],\n \"message\": \"

Notebook execution finished. Preview, JSON, log

\",\n \"runCount\": 2,\n \"runId\": \"20250923074329_f72deceb-c261-48ee-a355-56de0d37be92\",\n \"startDate\": \"2025-09-23T07:43:29.564Z\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"notebook1\",\n \"pluginId\": \"notebook_blank\",\n \"isEnabled\": false,\n \"tags\": []\n}" '401': description: Authentication failed (unauthorized). '403': description: Authorization failed (incorrect permissions). '404': description: The notebook doesn't exist. '503': description: The server is too busy to handle the request. security: - oauth2: - read:notebooks /notebooks/{notebook}/runs: get: tags: - Notebooks summary: Get run history for a notebook description: Returns the run history of a notebook batch execution. operationId: getNotebookRunHistory parameters: - name: notebook in: path description: The ID of the notebook. required: true schema: type: string examples: UUID of the notebook: description: UUID of the notebook value: ce016360-28ae-4e05-952a-cb5f642cd2b7 - 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 responses: '200': description: Returns the run history entries. content: application/json: schema: $ref: '#/components/schemas/NotebookStatusBeans' examples: Response body: description: Response body value: "{\n \"runs\": [\n {\n \"endDate\": \"2025-09-23T07:43:34.567Z\",\n \"goalStatistics\": [],\n \"message\": \"

Notebook execution finished. Preview, JSON, log

\",\n \"runCount\": 2,\n \"runId\": \"20250923074329_f72deceb-c261-48ee-a355-56de0d37be92\",\n \"startDate\": \"2025-09-23T07:43:29.564Z\",\n \"state\": \"FINISHED\"\n },\n {\n \"endDate\": \"2025-09-23T07:43:07.609Z\",\n \"goalStatistics\": [],\n \"message\": \"

Notebook execution finished. Preview, JSON, log

\",\n \"runCount\": 1,\n \"runId\": \"20250923074258_f72deceb-c261-48ee-a355-56de0d37be92\",\n \"startDate\": \"2025-09-23T07:42:58.446Z\",\n \"state\": \"FINISHED\"\n }\n ],\n \"itemsPerPage\": 10,\n \"startIndex\": 0,\n \"totalPages\": 1,\n \"totalResults\": 2\n}" '401': description: Authentication failed (unauthorized). '403': description: Authorization failed (incorrect permissions). '404': description: The notebook doesn't exist. '503': description: The server is too busy to handle the request. security: - oauth2: - read:notebooks components: schemas: SimpleRoleBean: type: object description: A role with id and name. properties: id: type: string description: Unique identifier of the role. name: type: string description: Name of the role. notebooks: type: object properties: itemsPerPage: type: integer format: int32 description: Number of results per page. readOnly: true notebooks: type: array items: $ref: '#/components/schemas/notebook' startIndex: type: integer format: int32 description: The start index. readOnly: true totalPages: type: integer format: int32 description: The total number of pages. readOnly: true totalResults: type: integer format: int32 description: The total number of results. readOnly: true NotebookStatusBeans: type: object description: A collection of notebook run status entries. properties: entries: type: array description: List of notebook run status entries items: $ref: '#/components/schemas/status' itemsPerPage: type: integer format: int32 description: Number of results per page. readOnly: true runs: type: array description: List of notebook run status entries items: $ref: '#/components/schemas/status' startIndex: type: integer format: int32 description: The start index. readOnly: true totalPages: type: integer format: int32 description: The total number of pages. readOnly: true totalResults: type: integer format: int32 description: The total number of results. readOnly: true status: type: object description: Notebook run status. properties: endDate: type: string format: date-time description: The end date of the run. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z". readOnly: true goalStatistics: type: array description: The goal statistics items: $ref: '#/components/schemas/property' lane: type: string description: The lane in which this run was executed enum: - REGULAR - REGULAR2 - REGULAR3 - REGULAR4 - REGULAR5 - REGULAR6 - REGULAR7 - REGULAR8 - EXPRESS - RUN_NOW - CONTINUOUS message: type: string description: The message of the run runCount: type: integer format: int64 description: The run count runId: type: string description: The run id startDate: type: string format: date-time description: The start date of the run. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z". readOnly: true state: type: string description: The state of the run enum: - STARTING - RUNNING - FINISHED - FAILED - STOPPING - STOPPED 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 property: type: object description: A property consisting of an ID and a list of values. properties: id: type: string description: The ID of the property. values: type: array description: Values for this property. items: type: string description: Values for this property. notebook: type: object properties: creationDate: type: string format: date-time description: The creation date of the object. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z". readOnly: true creator: $ref: '#/components/schemas/UserBean' description: type: string description: The description. id: type: string description: The object ID. isEnabled: type: boolean description: Indicates whether it is enabled lastModifiedDate: type: string format: date-time description: The last modified date of the object. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z". readOnly: true lastModifiedUser: $ref: '#/components/schemas/UserBean' lastRun: $ref: '#/components/schemas/status' name: type: string description: The object name. roles: type: array description: Roles allowed to edit this notebook; empty means no role-based restriction items: $ref: '#/components/schemas/SimpleRoleBean' tags: type: array description: The tags (i.e. labels). example: Address items: type: string description: The tags (i.e. labels). example: Address required: - roles 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*.
**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.

To use a Bearer token for authentication, follow these steps:
1. Acquire the token through authentication.
2. Include the token in the request''s Authorization header as Bearer \.
3. Send the request to access protected resources.
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