openapi: 3.2.0 info: title: analytics/odag-links Link API version: '' servers: - url: https://{tenant}.{region}.qlikcloud.com variables: region: default: us description: The region the tenant is hosted in tenant: default: your-tenant description: Name of the tenant that will be called tags: - name: Link 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/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 components: schemas: 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. LinkPropLimitPolicyV2: type: object required: - context - limitPolicy properties: context: $ref: '#/components/schemas/LinkUsageContextV2' limitPolicy: enum: - Restrict - AutoDelete type: string description: The action to take when the limit to the maximum number of generated Analytics Applications is reached. LinkStatusV2: enum: - active - disabled - decommissioned - incomplete type: string description: The current status of a link. LinkPutPayloadV2: type: object required: - name - selectionApp properties: name: $ref: '#/components/schemas/LinkNameV2' ownerId: $ref: '#/components/schemas/UserIdV2' 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 Analytics Application load script in the generated Analytics Application. The default value is `false`. statusSetting: $ref: '#/components/schemas/LinkStatusSettingV2' description: An object that defines the properties of a Link to be modified. LinkUsageContextV2: type: string description: An expression based on the usage environment of a Link typically including predicates that test the current user's membership in a group or possession of a user role that when evaluated truthfully enables an applicable value for a Link property. For example, `User_*` indicates that the link property setting applies to all users while `User.name = joe` indicates the rule applies only to a specific user named `joe`. LinkPropOverrideGenAppLimitV2: type: object required: - context properties: context: $ref: '#/components/schemas/LinkUsageContextV2' overrideGenAppLimit: type: boolean default: false description: The limit to the number of Analytics Applications generated can be overridden using this specific Link that can exist, and still not deleted. The default value for this property is `false`. If this property value is set to `true`, then the `limit` value in `genAppLimit` is ignored. SelAppLinkUsagePayload: type: object required: - linkList properties: linkList: type: array items: type: string description: An array of Link IDs. description: A JSON payload containing an array of LinkIds. 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. LinkPropAppOpenMethodV2: type: object required: - context - openMethod properties: context: $ref: '#/components/schemas/LinkUsageContextV2' openMethod: enum: - Tab - Window type: string default: Tab description: Sets the default method by which the newly generated Analytics Application is displayed when opened. The default is `Tab` to open a new tab in the same browser. Note that not all devices permit both methods so the chosen behavior may not apply if it is not supported on the user's device or browser. UserStateCondensedV2: type: object required: - id - name - subject - tenantid properties: id: $ref: '#/components/schemas/UserIdV2' name: type: string subject: type: string description: Identity subject used for identity mapping. tenantid: type: string description: Tenant identifier. description: Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request). 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. LinkPropRowEstRangeV2: type: object required: - context - highBound properties: context: $ref: '#/components/schemas/LinkUsageContextV2' lowBound: type: integer description: The minimum value for the row estimate to enable usage of the link to perform an ODAG request. If the row estimate expression evaluates to a number lower than this value, the user will be prevented from submitting an ODAG request for this link. If this value is not supplied, no minimum is required. highBound: type: integer description: The maximum value for the row estimate to enable usage of the link. If the row estimate expression evaluates to a value larger than this value, the user will be prevented from submitting an ODAG request for this link. description: A link property that defines a value range that the evaluated value of the row estimate measure must fall within in order to allow submissions of a request for the link. MetaV2: type: object properties: statusCode: type: integer format: int32 description: 'The HTTP status code for the error. Generally speaking, the following codes have these meanings: `200` - Success, `201` - Success (object created), `400` - Error with user input, `403` - Authorization error (user lacks permission), `404` - Object not found, `409` - Attempt to change an object using an obsolete last ModifiedDate.' description: Additional metadata associated with an error. 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 Analytics Application load script in the generated Analytics Application. The default value is `false`. statusSetting: $ref: '#/components/schemas/LinkStatusSettingV2' description: An object that defines the properties of a Link to be created. 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. LinkPropAppRetentionTimeV2: type: object required: - context - retentionTime properties: context: $ref: '#/components/schemas/LinkUsageContextV2' retentionTime: type: string description: A string that defines the length of time that a generated Analytics Application should be allowed to exist before it is automatically purged. The format must be in either ISO 8601 duration format or the text `unlimited`. LinkStateFullV2: type: object required: - id - createdDate - owner - name - status - templateApp - properties - rowEstExpr properties: id: type: string format: ObjectId name: $ref: '#/components/schemas/LinkNameV2' owner: $ref: '#/components/schemas/UserStateCondensedV2' status: $ref: '#/components/schemas/LinkStatusV2' bindings: $ref: '#/components/schemas/BindingArrayV2' privileges: type: array items: type: string properties: $ref: '#/components/schemas/LinkPropertiesV2' rowEstExpr: $ref: '#/components/schemas/LinkRowEstExprV2' createdDate: type: string format: date-time example: '2025-11-11T13:45:30Z' dynamicView: type: boolean description: When `true`, the ODAG link is treated as a dynamic view. templateApp: $ref: '#/components/schemas/AppStateCondensedV2' modifiedDate: type: string format: date-time example: '2025-11-11T13:45:30Z' sourceLinkId: type: string readOnly: true description: The ID of the original link this was copied from. Present only on deep-copied links. includeScript: type: boolean default: false description: Set to `true` to include the generated Analytics Application load script in the generated Analytics Application. The default value is `false`. x-omitempty: false modifiedByUser: $ref: '#/components/schemas/UserStateCondensedV2' genAppAccessible: type: boolean description: Only returned on `LinkGet` and set to `true` if user will have access to an Analytics Application generated by this link. templateAppChartObjects: type: array items: type: object description: The full state of a Link. SelectAppParamTypeV2: enum: - Field - Variable - Property - Exclude - BDI type: string description: The different kinds of selection Analytics Application parameters whose values can be bound to the script of template Analytics Applications when generating new Analytics Applications. Note that `Exclude` is used to specifically prevent fields defined as optional bind parameters in the template Analytics Application script from being bound (these must either not have the optional quantity constraint specifiers or have a minimum quantity of 0). LinkPropMenuLabelV2: type: object required: - context - label properties: label: type: string context: $ref: '#/components/schemas/LinkUsageContextV2' description: The default label to use for this Link in the context of the selection Analytics Application's ODAG navigation menu. LinkTypeV2: enum: - link - view - all type: string default: link description: The type of link LinkStatusSettingV2: enum: - activate - disable - decommission type: string description: 'The requested status transition to apply to a Link. New links are always created with status `active`; `statusSetting` is ignored. When updating a Link, if `statusSetting` is provided, the request updates the Link''s `status` only (other fields in the payload are not applied). If omitted, the Link''s status is not changed. `statusSetting` is an action, and it maps to the resulting `status`: - `activate` sets `status` to `active`. - `disable` sets `status` to `disabled`. - `decommission` sets `status` to `decommissioned`. If `statusSetting` has an unsupported value, the request returns an error and the Link is not updated. Links with status `decommissioned` cannot change status.' LinkStateRefV2: type: object required: - id properties: id: $ref: '#/components/schemas/LinkId' link: $ref: '#/components/schemas/LinkStateFullV2' description: Used to return a possibly empty link state when querying multiple links by ID where any one of those IDs may be invalid or obsolete. If the `link` field is missing, it means there was no accessible link for the corresponding `id`. LinkPropGenAppNameV2: type: object required: - context - formatString properties: params: type: array items: $ref: '#/components/schemas/AppNameParameterV2' context: $ref: '#/components/schemas/LinkUsageContextV2' formatString: type: string description: A string containing the base text of the name to use for the generated Analytics Application and optionally any number of placeholder patterns of the form `{N}` where `N` is an integer greater than or equal to `0`. The integer identifies the offset in the `params` array of an `AppNameParameterV2` to evaluate at ODAG Request execution time to compute a fragment of the generated Analytics Application's name and insert it at the same position as its corresponding `{N}` placeholder. description: An object that defines how to compute the name to use for the generated Analytics Application. 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. UserIdV2: type: string example: wcgIs6wGcDdyzep9QmyopWvNH1FJTOhh description: The system-assigned ID for a user 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. LinkPropGenAppLimitV2: type: object required: - context - limit properties: limit: type: integer context: $ref: '#/components/schemas/LinkUsageContextV2' description: The limit to the number of Analytics Applications generated using this specific Link that can exist, and still not deleted, before the policy defined by the `limitPolicy` property (configured separately via LinkPropertiesV2.limitPolicy) is applied. If no `limitPolicy` is defined, the `Restrict` policy is assumed. If there is no value for this property applicable to the current user, there is no limit to the number of Analytics Applications that can be generated from this link for the user. The count of the current number of Analytics Applications is based on just those Analytics Applications generated by the current user (and still in existence) for this specific link. The minimum value for `limit` is `1`. LinkPropDisableV2: type: object required: - context - disable properties: context: $ref: '#/components/schemas/LinkUsageContextV2' disable: type: boolean description: Set to `true` to temporarily disable the use of this Link to generate Analytics Applications. AppIdV2: type: string minLength: 1 description: The system-assigned ID for an Analytics Application. SelectionStateDescrV2: type: string description: A combination of the letters `S` and/or `O` to indicate which values from the selection states `selected` or `optional` in the hypercube of the selection Analytics Application to harvest as bind values to inject into the script of the template Analytics Application at ODAG request submission time. This is currently only settable in the template Analytics Application script and not when creating or updating a Link. LinkPropertiesV2: type: object required: - rowEstRange properties: disable: type: array items: $ref: '#/components/schemas/LinkPropDisableV2' menuLabel: type: array items: $ref: '#/components/schemas/LinkPropMenuLabelV2' genAppName: type: array items: $ref: '#/components/schemas/LinkPropGenAppNameV2' genAppLimit: type: array items: $ref: '#/components/schemas/LinkPropGenAppLimitV2' limitPolicy: type: array items: $ref: '#/components/schemas/LinkPropLimitPolicyV2' rowEstRange: type: array items: $ref: '#/components/schemas/LinkPropRowEstRangeV2' targetSheet: type: array items: $ref: '#/components/schemas/LinkPropTargetSheetV2' appOpenMethod: type: array items: $ref: '#/components/schemas/LinkPropAppOpenMethodV2' appRetentionTime: type: array items: $ref: '#/components/schemas/LinkPropAppRetentionTimeV2' overrideGenAppLimit: type: array items: $ref: '#/components/schemas/LinkPropOverrideGenAppLimitV2' description: The complete set of possible properties for a link and their associated user context/value pairings. 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. NumericOnlyV2: type: boolean default: false description: Set to `true` to indicate that only numeric values from the selection Analytics Application source parameter should be used. The default value for this property, if left unspecified, is `false`. This is currently only settable in the template Analytics Application script and not when creating or updating a Link. AppNameV2: type: string example: appname minLength: 1 description: The name of an Analytics Application. ValueCountRangeV2: type: object properties: lowerBound: type: integer upperBound: type: integer description: The lower and upper bound for the permitted number of values that must exist in the selection Analytics Application's source parameter in order for this binding to be valid (and permit an ODAG Request to be submitted. If this property is not supplied, there is no constraint on either the lower or upper bound. To indicate that an exact number of selections are required, use the same number for both the lower and upper bound. LinkPropTargetSheetV2: type: object required: - context - sheetId properties: context: $ref: '#/components/schemas/LinkUsageContextV2' sheetId: type: string description: The ID of the sheet to first navigate to when opening the generated Analytics Application from the selection Analytics Application. sheetName: type: string description: An optional, read-only property that is returned when retrieving a link if the `targetSheet` setting exists for the current user in the link's `properties` set and the sheet with that ID exists in the link's `templateApp`. description: An optional property that a Link creator can specify to cause the client to navigate to a specific sheet in the generated Analytics Application when opening the generated Analytics Application from the selection Analytics Application's navpoint panel. LinkRowEstExprV2: type: string description: The measure expression to be evaluated in the context of the selection Analytics Application for the link that estimates the number of records that will be qualified by the primary load query of the template Analytics Application. This expression must be valid in the context of the selection Analytics Application fields and update whenever the selection state of the selection Analytics Application changes. LinkNameV2: type: string example: ODAG Link name maxLength: 255 minLength: 1 description: The name of a link. LinkId: type: string pattern: ^[a-fA-F0-9]{24}$ description: The system-assigned ID for a link. 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.