Create, manage, and retrieve on-demand analytics generation links between selection and template applications.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/analytics-odag-links-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "analytics/odag-links",
"version": ""
},
"paths": {
"/api/analytics/odag-links": {
"get": {
"tags": [
"Link"
],
"summary": "List ODAG links",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkStateFullV2"
},
"title": "Array Of LinkStateFull"
}
}
},
"description": "ODAG links retrieved successfully."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "ODAG not enabled or access denied."
}
},
"parameters": [
{
"in": "query",
"name": "includeCharts",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Determines whether master charts of the template Analytics Application are included in the response."
},
{
"in": "query",
"name": "selectionAppID",
"schema": {
"type": "string"
},
"required": false,
"description": "Filter the list by the selection Analytics Application ID."
},
{
"in": "query",
"name": "type",
"schema": {
"$ref": "#/components/schemas/LinkTypeV2"
},
"required": false,
"description": "The type of the links to query. Defaults to `link`."
},
{
"$ref": "#/components/parameters/OptOwnedByV2"
}
],
"description": "A Link object defines an on-demand data navigation path between a selection Analytics Application and a template Analytics Application including the set of properties that control how that data access occurs and under what conditions access is permitted. The set of links returned by this method have properties that match the combination of conditions defined by any supplied query parameters.",
"operationId": "linksGetV2",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"Link"
],
"summary": "Create an ODAG link",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkStateFullV2"
}
}
},
"description": "ODAG link created successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid link payload (see detailed error)."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid referenced object ID (see detailed error message)."
}
},
"parameters": [
{
"in": "query",
"name": "includeCharts",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Determines whether master charts of the template Analytics Application are included in the response."
}
],
"description": "Creates a new link that enables ODAG navigation from a designated selection Analytics Application to a generated Analytics Application that is created by copying the designated template Analytics Application, injecting values for bind variables harvested from the selection Analytics Application and dynamically loaded with data using those bindings. The Bindings will be initialized by searching the load script of the template Analytics Application for patterns of the form `$(od_FIELDNAME)[M-N]` where `FIELDNAME` is the name of a field in the model of the selection Analytics Application and the optional pattern `[M-N]` identifies the lower bound `M` and the upper bound `N` for the number of values for that field which must be in the active selection state of the selection Analytics Application for binding to occur. The active selection state defaults to `selected` (i.e. green) unless the `od` prefix is immediately followed by some combination of the letters `s`, `o`, or `x`, in that order, specifically designating the `selected`, `optional` (i.e. white) and/or `excluded` (i.e. gray) groups of values to be harvested from the selection Analytics Application's selection state. The bindings in the `bindings` array in the request payload override the properties of the corresponding field bindings found in the script of the template Analytics Application.",
"operationId": "linkCreateV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkAddPayloadV2"
}
}
},
"required": true,
"description": "A JSON payload containing the content for a new ODAG link."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/analytics/odag-links/{linkId}": {
"get": {
"tags": [
"Link"
],
"summary": "Get ODAG link details",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkStateFullV2"
}
}
},
"description": "Successful response."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid link ID (see detailed error)."
}
},
"parameters": [
{
"in": "path",
"name": "linkId",
"schema": {
"$ref": "#/components/schemas/LinkId"
},
"required": true,
"description": "The ID of the link."
},
{
"in": "query",
"name": "includeCharts",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Determines whether master charts of the template Analytics Application are included in the response."
}
],
"description": "Retrieves details of a specific ODAG link, including bindings, properties, status, and template Analytics Application charts. Use this to review link configuration or verify permissions before generating Analytics Applications.",
"operationId": "linkGetV2",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"Link"
],
"summary": "Update an ODAG link",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkStateFullV2"
}
}
},
"description": "ODAG link updated successfully."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Link not found, ODAG not enabled, or invalid referenced object."
}
},
"parameters": [
{
"in": "path",
"name": "linkId",
"schema": {
"$ref": "#/components/schemas/LinkId"
},
"required": true,
"description": "The ID of the link."
},
{
"in": "query",
"name": "includeCharts",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Determines whether master charts of the template Analytics Application are included in the response."
}
],
"description": "Modifies ODAG link configuration including bindings, properties, status, and template Analytics Application reference. You can re-scan the template Analytics Application script to auto-detect binding patterns or override specific settings. If `statusSetting` is provided, the request updates only the link status (other payload fields are not applied).",
"operationId": "linkUpdateV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkPutPayloadV2"
}
}
},
"required": true,
"description": "A JSON payload containing the updated configuration for the ODAG link."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/analytics/odag-links/{linkId}/requests": {
"get": {
"tags": [
"Request"
],
"summary": "List requests for an ODAG link",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestArrayV2"
}
}
},
"description": "Successful response - see array of requests in response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Link not found or ODAG service error (see detailed error)."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "ODAG not enabled or access denied."
}
},
"parameters": [
{
"in": "path",
"name": "linkId",
"schema": {
"$ref": "#/components/schemas/LinkId"
},
"required": true,
"description": "The ID of the link."
},
{
"in": "query",
"name": "clientContextHandle",
"schema": {
"type": "string"
},
"required": false,
"description": "An opaque handle to a client-side object that contains the reference to the link being used."
},
{
"in": "query",
"name": "pending",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Pass `true` if only pending requests should be returned."
},
{
"in": "query",
"name": "selectionAppId",
"schema": {
"type": "string"
},
"required": false,
"description": "The ID of the selection Analytics Application."
},
{
"in": "query",
"name": "selectionAppSheet",
"schema": {
"type": "string"
},
"required": false,
"description": "The name (or ID) of the sheet to filter qualifying ODAG requests for a selection Analytics Application."
}
],
"description": "Retrieves all Analytics Application generation requests for a specific ODAG link, with optional filtering by pending status (`pending`), selection Analytics Application (`selectionAppId`), sheet context (`selectionAppSheet`), or client context (`clientContextHandle`). Use this to track generation history or monitor in-flight requests.",
"operationId": "linkRequestsGetV2",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"Request"
],
"summary": "Submit an ODAG request",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestObjectV2"
}
}
},
"description": "Successful response - the request has been queued."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "The selection Analytics Application was in an invalid state to proceed with this Analytics Application generation (see detailed error)."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid link ID."
}
},
"parameters": [
{
"in": "path",
"name": "linkId",
"schema": {
"$ref": "#/components/schemas/LinkId"
},
"required": true,
"description": "The ID of the link."
}
],
"description": "Submits a new Analytics Application generation request with the current selection state from a selection Analytics Application. The request is validated against link properties before queuing. On success, returns a request object that you must monitor for completion using the status endpoint. Validation failures return detailed error information.",
"operationId": "linkRequestCreateV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestPostPayloadV2"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/analytics/odag-links/cancreate": {
"get": {
"tags": [
"Link"
],
"summary": "Check create link permission",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CanCreateLinks"
}
}
},
"description": "Successful response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid parameter values (see detailed error)."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "ODAG not enabled."
}
},
"parameters": [
{
"in": "query",
"name": "optDenyIfSelAppNotUpdatable",
"schema": {
"type": "boolean"
},
"required": false,
"description": "When `true`, deny permission if the selection Analytics Application cannot be updated. This parameter is ignored unless `optSelectAppId` is also supplied."
},
{
"in": "query",
"name": "optSelectAppId",
"schema": {
"type": "string"
},
"required": false,
"description": "An optional parameter for specifying the ID of a selection Analytics Application."
},
{
"in": "query",
"name": "optTemplateAppId",
"schema": {
"type": "string"
},
"required": false,
"description": "An optional parameter for specifying the ID of a template Analytics Application."
}
],
"description": "Checks whether the current user has permission to create new ODAG links. Optionally verify permissions for a specific template Analytics Application or selection Analytics Application context. Returns a boolean indicating create permission status.",
"operationId": "linkCanCreateV2",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/analytics/odag-links/selection-app-link-usages": {
"post": {
"tags": [
"Link"
],
"summary": "List ODAG links used by a selection Analytics Application",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkStateRefV2"
},
"title": "Array of LinkStateFull"
}
}
},
"description": "Successful response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid parameter values or link list (see detailed error)."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Forbidden."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV2"
}
}
},
"description": "Invalid selection Analytics Application ID or link ID supplied (see detailed error message)."
}
},
"parameters": [
{
"in": "query",
"name": "selAppId",
"schema": {
"type": "string"
},
"required": true,
"description": "The ID of a selection Analytics Application."
},
{
"in": "query",
"name": "includeCharts",
"schema": {
"type": "boolean"
},
"required": false,
"description": "When `true`, include master charts from the template Analytics Application in the response."
},
{
"in": "query",
"name": "type",
"schema": {
"$ref": "#/components/schemas/LinkTypeV2"
},
"required": false,
"description": "The type of the links to query. Defaults to `link`."
}
],
"description": "Registers the current set of ODAG links referenced by a selection Analytics Application and returns only those links the current user can access. Call this when a selection Analytics Application is opened or after modifying its ODAG link references. The response is an array of objects, where the `id` identifies the requested link and `link` contains the link state when accessible. Use `GET /analytics/odag-links/{linkId}` for full details.",
"operationId": "syncAppLinkUsagesV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelAppLinkUsagePayload"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
}
},
"openapi": "3.0.0",
"components": {
"parameters": {
"OptOwnedByV2": {
"in": "query",
"name": "optOwner",
"schema": {
"type": "string"
},
"required": false,
"description": "Use `optOwner` to filter results by link owner user ID. If supplied, only links owned by that user are returned. If not supplied, returns all links the current user can access."
}
},
"schemas": {
"AppIdV2": {
"type": "string",
"minLength": 1,
"description": "The system-assigned ID for an Analytics Application."
},
"AppNameParameterV2": {
"enum": [
"templateAppName",
"userId",
"curYear",
"curMonth",
"curDay",
"curHr",
"curMin",
"curSec"
],
"type": "string",
"description": "One of the allowed variables that, when evaluated at ODAG Request execution time, can be used to compute a part of a generated Analytics Application's name."
},
"AppNameV2": {
"type": "string",
"example": "appname",
"minLength": 1,
"description": "The name of an Analytics Application."
},
"AppStateCondensedV2": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AppIdV2"
},
"name": {
"$ref": "#/components/schemas/AppNameV2"
}
},
"description": "Condensed state of an Analytics Application returned in `state` for Link, LinkUsage, Request, and ODAG Apps GET calls."
},
"BindFormattingV2": {
"type": "object",
"properties": {
"quote": {
"type": "string",
"default": "'",
"description": "The character to use for quote wrapping each of the bound values when formatting the source values associated with this binding. If this property is not supplied, a single quote character (`'`) will be used by default. Use an empty string to suppress quote wrapping the values."
},
"delimiter": {
"type": "string",
"default": ",",
"description": "The character to use as a separator between two (or more) bound values when formatting the source values associated with this binding. If this property is not supplied, a comma character will be used by default. Use an empty string to indicate that no separator character should be used."
}
},
"description": "A property value that describes the formatting of field values in a Binding. This is currently only settable in the template Analytics Application script and not when creating or updating a Link."
},
"BindingArrayV2": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BindingV2"
},
"description": "A collection of Bindings. Note that there can be multiple bindings having the same `templateAppFieldName` in a binding collection to denote different usages of the field's selection state in the context of the data prep logic but they all must have the same value for their `range` property."
},
"BindingV2": {
"type": "object",
"required": [
"templateAppVarName",
"selectAppParamType"
],
"properties": {
"range": {
"$ref": "#/components/schemas/ValueCountRangeV2"
},
"formatting": {
"$ref": "#/components/schemas/BindFormattingV2"
},
"numericOnly": {
"$ref": "#/components/schemas/NumericOnlyV2"
},
"selectionStates": {
"$ref": "#/components/schemas/SelectionStateDescrV2"
},
"selectAppParamName": {
"type": "string",
"description": "The path (or name) of the selection Analytics Application field, variable, or property to obtain the list of values for this binding."
},
"selectAppParamType": {
"$ref": "#/components/schemas/SelectAppParamTypeV2"
},
"templateAppVarName": {
"type": "string"
}
},
"description": "An object that defines how values accessible in the selection Analytics Application are to be harvested and injected into the data prep phase of the template Analytics Application at Analytics Application generation time."
},
"CanCreateLinks": {
"type": "object",
"properties": {
"canCreateLinks": {
"type": "boolean"
}
},
"description": "An object used to inform the caller whether the current user has privilege to create new Links."
},
"DataLoadStatus": {
"enum": [
"pending",
"success",
"warnings",
"failed"
],
"type": "string",
"description": "The completion status of a completed Request."
},
"ErrorDetailsV2": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A unique code used to identify the template form of the message in i18n tables (language independent)."
},
"meta": {
"$ref": "#/components/schemas/MetaV2"
},
"title": {
"type": "string"
},
"detail": {
"type": "string",
"description": "The message describing the error."
}
},
"description": "A single error entry within an error response."
},
"ErrorV2": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetailsV2"
}
},
"traceId": {
"type": "string",
"description": "A unique ID of the trace which the error occurred in. Makes it possible to locate involved services and find log messages from the time of the error."
}
},
"description": "A standard error response containing a list of one or more errors."
},
"FieldSelectionStateV2": {
"type": "object",
"required": [
"selectionAppParamType",
"selectionAppParamName",
"values"
],
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldValueV2"
},
"description": "The list of values in the selection state for this field."
},
"selectedSize": {
"type": "integer",
"description": "The actual number of selected values. Not used for `bindSelectionState`."
},
"selectionAppParamName": {
"type": "string",
"description": "The name of a variable or field that corresponds to one or more bindings having a matching `selectAppParamName` used to generate Analytics Applications."
},
"selectionAppParamType": {
"$ref": "#/components/schemas/SelectAppParamTypeV2"
}
},
"description": "The set of values used by link bindings to generate an Analytics Application."
},
"FieldValueV2": {
"type": "object",
"required": [
"strValue",
"selStatus"
],
"properties": {
"numValue": {
"type": "string"
},
"strValue": {
"type": "string"
},
"selStatus": {
"$ref": "#/components/schemas/SelectStatusV2"
}
},
"description": "A single field value with its selection status."
},
"LinkAddPayloadV2": {
"type": "object",
"required": [
"name",
"selectionApp"
],
"properties": {
"name": {
"$ref": "#/components/schemas/LinkNameV2"
},
"bindings": {
"$ref": "#/components/schemas/BindingArrayV2"
},
"properties": {
"$ref": "#/components/schemas/LinkPropertiesV2"
},
"rowEstExpr": {
"$ref": "#/components/schemas/LinkRowEstExprV2"
},
"dynamicView": {
"type": "boolean",
"description": "When `true`, the ODAG link is treated as a dynamic view. Analytics Application retention time is overridden to `24 hours` and the maximum number of generated Analytics Applications is set to `1`."
},
"templateApp": {
"$ref": "#/components/schemas/AppIdV2"
},
"selectionApp": {
"$ref": "#/components/schemas/AppIdV2"
},
"includeScript": {
"type": "boolean",
"default": false,
"description": "Set to `true` to include the generated Analy
# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-analytics-odag-links.json