ODAG requests
ODAG requests represent user submissions through an ODAG link, triggering automatic generation of new analytics applications. Use this API to track request status, manage the lifecycle of generated applications (reload, rename, delete), and retrieve request details. Generated applications have a configurable retention period and are automatically purged after that period expires.
Endpoints
Retrieves the current status and details of an ODAG request, including its state (queued, loading, succeeded, failed), generated Analytics Application ID, and error information. For multi-application generation requests, includes nested status for each sub-request.
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters
- requestId stringRequired
The ID of the ODAG request whose status is to be returned.
Responses
200
Successful response - see request status in response.
- application/json object
The detailed content of an ODAG request object. If this is a summarization of a request initiated from a navigation point that has a single link, its
linkproperty refers to that link. Otherwise, a sub-request is created for each link in the navigation point and thelinkof each sub-request refers to its respective link. If this is asingleorsinglesubAnalytics Application generation request and the request has reached at least thequeuedstage, thegeneratedAppproperty contains the ID of the generated Analytics Application (note that the generated Analytics Application might not yet be populated with data or published if the request is not completed). If this is asingleorsinglesubrequest and the data load operation failed, thegeneratedAppproperty still contains the ID of the failed Analytics Application to allow viewing of the ODAG-bound script for diagnostic purposes. Generated Analytics Applications for failed requests are purged regularly, so the Analytics Application might no longer be available. If this is asingleorsinglesubrequest that was canceled before reaching theloadingphase, thegeneratedAppproperty is missing because generated Analytics Applications for pre-load phase requests are deleted. If this is amultiplerequest, thegeneratedAppproperty is also missing.application/json properties
- id stringRequired
The system-assigned ID for an ODAG request.
- kind stringRequired
For links that do not use any partitioning fields, a
singleAnalytics Application generation request is created. However, for selection Analytics Applications that designate a set of partitioning fields and the user selects multiple values for any of those partitioning fields, ODAG uses a separatesinglesubrequest to generate a separate Analytics Application for each combination of selected partition field values, and tracks the queuing and data load phase of each of those sub-requests separately. Note thatsinglesubrequests share the same link ID as their spawningmultipleparent request.Can be one of: "single""multiple""singlesub"
- link stringRequired
The system-assigned ID for a link.
- owner objectRequired
Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request).
owner properties
- id stringRequired
The system-assigned ID for a user
- name stringRequired
- subject stringRequired
Identity subject used for identity mapping.
- tenantid stringRequired
Tenant identifier.
-
- state stringRequired
The current state of an ODAG request.
Can be one of: "validating""queued""invalid""hold""loading""canceled""failed""succeeded""canceling""canceledAck""failedAck"
- loadState object
An object that describes the state of a generated Analytics Application's data load operation. In request objects that include this object as an optional property, the property will be missing for
multiplegeneration requests (see their sub-requests for their data load information) or forsingleandsinglesubrequests that have not yet reached theirloadingphase.loadState properties
- status string
The completion status of a completed Request.
Can be one of: "pending""success""warnings""failed"
- loadHost stringRequired
The engine host name used to perform the data load operation for this request. This property will be missing in
multiplegeneration requests (see theloadHostfield of their sub-requests) and will be an empty string on asingleorsinglesubrequest that has not yet reached theloadingphase. - startedAt stringRequired
- finishedAt string
-
- sheetname string
- purgeAfter string
- timeToLive integer
The value of the Link's
appRetentionTimeproperty at the time the Analytics Application was generated (0means no auto-purge). - validation array of strings
A list of validation errors or warnings.
- createdDate stringRequired
- targetSheet string
The ID of the target sheet, taken from the link properties, to navigate to when opening the generated Analytics Application (empty for Analytics Application overview).
- templateApp stringRequired
The system-assigned ID for an Analytics Application.
- actualRowEst integer
The evaluated value of the Link's
rowEstExprmeasure expression at the time this request was initiated. - errorMessage string
Detailed message if the request failed.
- generatedApp object
Condensed state of an Analytics Application returned in
statefor Link, LinkUsage, Request, and ODAG Apps GET calls.generatedApp properties
- id stringRequired
The system-assigned ID for an Analytics Application.
- name stringRequired
The name of an Analytics Application.
-
- modifiedDate stringRequired
- selectionApp string
The system-assigned ID for an Analytics Application.
- curRowEstExpr string
The Link's
rowEstExprproperty setting at the time this request was initiated. - retentionTime integer
The remaining time in minutes this request will be retained (0 means kept forever).
- parentRequestId string
The system-assigned ID for an ODAG request.
- templateAppName string
The name of an Analytics Application.
- bindingStateHash integer
A 64-bit hash of the bound field state at the time the request was made.
- generatedAppName string
The name of an Analytics Application.
- selectionAppName string
The name of an Analytics Application.
- curRowEstLowBound integer
The Link's
rowEstRange.lowBoundvalue for the user at the time this request was initiated. - curRowEstHighBound integer
The Link's
rowEstRange.highBoundvalue for the user at the time this request was initiated. - selectionStateHash integer
A 64-bit hash of the selected field values at the time the request was made.
-
403
Forbidden.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
404
Invalid request ID.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.odagRequests.getOdagRequest( 'string',)qlik analytics odag-request get 'string'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-requests/{requestId}" \-H "Authorization: Bearer <access_token>"Example Response
{ "id": "string", "kind": "single", "link": "string", "owner": { "id": "wcgIs6wGcDdyzep9QmyopWvNH1FJTOhh", "name": "string", "subject": "string", "tenantid": "string" }, "state": "validating", "loadState": { "status": "pending", "loadHost": "string", "startedAt": "2025-11-11T13:45:30Z", "finishedAt": "2025-11-11T13:45:30Z" }, "sheetname": "string", "purgeAfter": "2025-11-11T13:45:30Z", "timeToLive": 42, "validation": [ "string" ], "createdDate": "2025-11-11T13:45:30Z", "targetSheet": "string", "templateApp": "string", "actualRowEst": 42, "errorMessage": "string", "generatedApp": { "id": "string", "name": "appname" }, "modifiedDate": "2025-11-11T13:45:30Z", "selectionApp": "string", "curRowEstExpr": "string", "retentionTime": 42, "parentRequestId": "string", "templateAppName": "appname", "bindingStateHash": 42, "generatedAppName": "appname", "selectionAppName": "appname", "curRowEstLowBound": 42, "curRowEstHighBound": 42, "selectionStateHash": 42}Performs actions on ODAG requests such as pausing, resuming, or canceling them. Cancel actions are effective only before the data loading phase. For multi-application generation requests, actions apply only to sub-requests that have not yet started loading. Automatic acknowledgment option simplifies state transitions.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Query Parameters
- action stringRequired
The action to perform on the request. One of: (1)
cancela pending or in-flight request; (2)pausea request that has not started (still in thequeuedstate); (3)resumea paused request; (4) acknowledge a prior cancellation; or (5) acknowledge a prior failure.Can be one of: "cancel""pause""resume""ackcancel""ackfailure"
- autoAck boolean
Optional flag used with the
cancelaction. WhenautoAckistrue, a canceled request automatically transitions to thecanceledAckstate after cancellation completes. WhenautoAckisfalse, the request transitions tocanceled, and you must call this endpoint again withaction=ackcancelto acknowledge the cancellation. - delGenApp boolean
Optional flag that deletes the generated Analytics Application after an
actionofcancel(withautoAck=true),ackcancel, orackfailure. - ignoreSucceeded boolean
Optional flag used with the
cancelaction. Whentrue, the API does not return an error if the request reaches thesucceededstate while the cancellation request is in progress.
Path Parameters
- requestId stringRequired
The ID of the request whose status is to be returned.
Responses
200
Successful response - see request status in response.
- application/json object
The detailed content of an ODAG request object. If this is a summarization of a request initiated from a navigation point that has a single link, its
linkproperty refers to that link. Otherwise, a sub-request is created for each link in the navigation point and thelinkof each sub-request refers to its respective link. If this is asingleorsinglesubAnalytics Application generation request and the request has reached at least thequeuedstage, thegeneratedAppproperty contains the ID of the generated Analytics Application (note that the generated Analytics Application might not yet be populated with data or published if the request is not completed). If this is asingleorsinglesubrequest and the data load operation failed, thegeneratedAppproperty still contains the ID of the failed Analytics Application to allow viewing of the ODAG-bound script for diagnostic purposes. Generated Analytics Applications for failed requests are purged regularly, so the Analytics Application might no longer be available. If this is asingleorsinglesubrequest that was canceled before reaching theloadingphase, thegeneratedAppproperty is missing because generated Analytics Applications for pre-load phase requests are deleted. If this is amultiplerequest, thegeneratedAppproperty is also missing.application/json properties
- id stringRequired
The system-assigned ID for an ODAG request.
- kind stringRequired
For links that do not use any partitioning fields, a
singleAnalytics Application generation request is created. However, for selection Analytics Applications that designate a set of partitioning fields and the user selects multiple values for any of those partitioning fields, ODAG uses a separatesinglesubrequest to generate a separate Analytics Application for each combination of selected partition field values, and tracks the queuing and data load phase of each of those sub-requests separately. Note thatsinglesubrequests share the same link ID as their spawningmultipleparent request.Can be one of: "single""multiple""singlesub"
- link stringRequired
The system-assigned ID for a link.
- owner objectRequired
Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request).
owner properties
- id stringRequired
The system-assigned ID for a user
- name stringRequired
- subject stringRequired
Identity subject used for identity mapping.
- tenantid stringRequired
Tenant identifier.
-
- state stringRequired
The current state of an ODAG request.
Can be one of: "validating""queued""invalid""hold""loading""canceled""failed""succeeded""canceling""canceledAck""failedAck"
- loadState object
An object that describes the state of a generated Analytics Application's data load operation. In request objects that include this object as an optional property, the property will be missing for
multiplegeneration requests (see their sub-requests for their data load information) or forsingleandsinglesubrequests that have not yet reached theirloadingphase.loadState properties
- status string
The completion status of a completed Request.
Can be one of: "pending""success""warnings""failed"
- loadHost stringRequired
The engine host name used to perform the data load operation for this request. This property will be missing in
multiplegeneration requests (see theloadHostfield of their sub-requests) and will be an empty string on asingleorsinglesubrequest that has not yet reached theloadingphase. - startedAt stringRequired
- finishedAt string
-
- sheetname string
- purgeAfter string
- timeToLive integer
The value of the Link's
appRetentionTimeproperty at the time the Analytics Application was generated (0means no auto-purge). - validation array of strings
A list of validation errors or warnings.
- createdDate stringRequired
- targetSheet string
The ID of the target sheet, taken from the link properties, to navigate to when opening the generated Analytics Application (empty for Analytics Application overview).
- templateApp stringRequired
The system-assigned ID for an Analytics Application.
- actualRowEst integer
The evaluated value of the Link's
rowEstExprmeasure expression at the time this request was initiated. - errorMessage string
Detailed message if the request failed.
- generatedApp object
Condensed state of an Analytics Application returned in
statefor Link, LinkUsage, Request, and ODAG Apps GET calls.generatedApp properties
- id stringRequired
The system-assigned ID for an Analytics Application.
- name stringRequired
The name of an Analytics Application.
-
- modifiedDate stringRequired
- selectionApp string
The system-assigned ID for an Analytics Application.
- curRowEstExpr string
The Link's
rowEstExprproperty setting at the time this request was initiated. - retentionTime integer
The remaining time in minutes this request will be retained (0 means kept forever).
- parentRequestId string
The system-assigned ID for an ODAG request.
- templateAppName string
The name of an Analytics Application.
- bindingStateHash integer
A 64-bit hash of the bound field state at the time the request was made.
- generatedAppName string
The name of an Analytics Application.
- selectionAppName string
The name of an Analytics Application.
- curRowEstLowBound integer
The Link's
rowEstRange.lowBoundvalue for the user at the time this request was initiated. - curRowEstHighBound integer
The Link's
rowEstRange.highBoundvalue for the user at the time this request was initiated. - selectionStateHash integer
A 64-bit hash of the selected field values at the time the request was made.
-
403
Forbidden.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
404
Invalid request ID.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.odagRequests.updateOdagRequest( 'string', { action: 'cancel' },)qlik analytics odag-request update 'string' \ --action 'cancel'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-requests/{requestId}" \-X PUT \-H "Authorization: Bearer <access_token>"Example Response
{ "id": "string", "kind": "single", "link": "string", "owner": { "id": "wcgIs6wGcDdyzep9QmyopWvNH1FJTOhh", "name": "string", "subject": "string", "tenantid": "string" }, "state": "validating", "loadState": { "status": "pending", "loadHost": "string", "startedAt": "2025-11-11T13:45:30Z", "finishedAt": "2025-11-11T13:45:30Z" }, "sheetname": "string", "purgeAfter": "2025-11-11T13:45:30Z", "timeToLive": 42, "validation": [ "string" ], "createdDate": "2025-11-11T13:45:30Z", "targetSheet": "string", "templateApp": "string", "actualRowEst": 42, "errorMessage": "string", "generatedApp": { "id": "string", "name": "appname" }, "modifiedDate": "2025-11-11T13:45:30Z", "selectionApp": "string", "curRowEstExpr": "string", "retentionTime": 42, "parentRequestId": "string", "templateAppName": "appname", "bindingStateHash": 42, "generatedAppName": "appname", "selectionAppName": "appname", "curRowEstLowBound": 42, "curRowEstHighBound": 42, "selectionStateHash": 42}Deletes the generated Analytics Application associated with a completed request. Only the request owner or ODAG link creator can delete generated Analytics Applications.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Path Parameters
- requestId stringRequired
The ID of the request.
Responses
204
Successful response - No Content.
403
Insufficient privilege to delete the generated Analytics Application. User must be either owner of the request or the ODAG link.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
404
Invalid request ID or generated Analytics Application not found.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.odagRequests.deleteOdagRequestApp( 'string',)qlik analytics odag-request app rm 'string'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-requests/{requestId}/app" \-X DELETE \-H "Authorization: Bearer <access_token>"Reloads data in a generated Analytics Application from the underlying data sources. Only the request owner or ODAG link creator can reload generated Analytics Applications.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Path Parameters
- requestId stringRequired
The ID of the request.
Request Body
Required- application/json object
Payload to send when reloading an Analytics Application generated by an ODAG request.
application/json properties
- copyRequest boolean
Determines whether the request should be copied along with the generated Analytics Application.
- actualRowEst integer
The current row estimate value calculated by the link's
rowEstExprproperty in the context of the selection Analytics Application. - selectionState array of objects
A collection of FieldSelectionStateV2 objects.
selectionState properties
- values array of objectsRequired
The list of values in the selection state for this field.
values properties
- numValue string
- strValue stringRequired
- selStatus stringRequired
The valid set of selection states that a specific field value can be in. One of:
S(selected),O(optional), orX(excluded).Can be one of: "S""O""X"
-
- selectedSize integer
The actual number of selected values. Not used for
bindSelectionState. - selectionAppParamName stringRequired
The name of a variable or field that corresponds to one or more bindings having a matching
selectAppParamNameused to generate Analytics Applications. - selectionAppParamType stringRequired
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
Excludeis 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).Can be one of: "Field""Variable""Property""Exclude""BDI"
-
- bindSelectionState array of objects
A collection of FieldSelectionStateV2 objects.
bindSelectionState properties
- values array of objectsRequired
The list of values in the selection state for this field.
values properties
- numValue string
- strValue stringRequired
- selStatus stringRequired
The valid set of selection states that a specific field value can be in. One of:
S(selected),O(optional), orX(excluded).Can be one of: "S""O""X"
-
- selectedSize integer
The actual number of selected values. Not used for
bindSelectionState. - selectionAppParamName stringRequired
The name of a variable or field that corresponds to one or more bindings having a matching
selectAppParamNameused to generate Analytics Applications. - selectionAppParamType stringRequired
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
Excludeis 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).Can be one of: "Field""Variable""Property""Exclude""BDI"
-
-
Responses
200
Successful response. Returns the updated request state.
- application/json object
The detailed content of an ODAG request object. If this is a summarization of a request initiated from a navigation point that has a single link, its
linkproperty refers to that link. Otherwise, a sub-request is created for each link in the navigation point and thelinkof each sub-request refers to its respective link. If this is asingleorsinglesubAnalytics Application generation request and the request has reached at least thequeuedstage, thegeneratedAppproperty contains the ID of the generated Analytics Application (note that the generated Analytics Application might not yet be populated with data or published if the request is not completed). If this is asingleorsinglesubrequest and the data load operation failed, thegeneratedAppproperty still contains the ID of the failed Analytics Application to allow viewing of the ODAG-bound script for diagnostic purposes. Generated Analytics Applications for failed requests are purged regularly, so the Analytics Application might no longer be available. If this is asingleorsinglesubrequest that was canceled before reaching theloadingphase, thegeneratedAppproperty is missing because generated Analytics Applications for pre-load phase requests are deleted. If this is amultiplerequest, thegeneratedAppproperty is also missing.application/json properties
- id stringRequired
The system-assigned ID for an ODAG request.
- kind stringRequired
For links that do not use any partitioning fields, a
singleAnalytics Application generation request is created. However, for selection Analytics Applications that designate a set of partitioning fields and the user selects multiple values for any of those partitioning fields, ODAG uses a separatesinglesubrequest to generate a separate Analytics Application for each combination of selected partition field values, and tracks the queuing and data load phase of each of those sub-requests separately. Note thatsinglesubrequests share the same link ID as their spawningmultipleparent request.Can be one of: "single""multiple""singlesub"
- link stringRequired
The system-assigned ID for a link.
- owner objectRequired
Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request).
owner properties
- id stringRequired
The system-assigned ID for a user
- name stringRequired
- subject stringRequired
Identity subject used for identity mapping.
- tenantid stringRequired
Tenant identifier.
-
- state stringRequired
The current state of an ODAG request.
Can be one of: "validating""queued""invalid""hold""loading""canceled""failed""succeeded""canceling""canceledAck""failedAck"
- loadState object
An object that describes the state of a generated Analytics Application's data load operation. In request objects that include this object as an optional property, the property will be missing for
multiplegeneration requests (see their sub-requests for their data load information) or forsingleandsinglesubrequests that have not yet reached theirloadingphase.loadState properties
- status string
The completion status of a completed Request.
Can be one of: "pending""success""warnings""failed"
- loadHost stringRequired
The engine host name used to perform the data load operation for this request. This property will be missing in
multiplegeneration requests (see theloadHostfield of their sub-requests) and will be an empty string on asingleorsinglesubrequest that has not yet reached theloadingphase. - startedAt stringRequired
- finishedAt string
-
- sheetname string
- purgeAfter string
- timeToLive integer
The value of the Link's
appRetentionTimeproperty at the time the Analytics Application was generated (0means no auto-purge). - validation array of strings
A list of validation errors or warnings.
- createdDate stringRequired
- targetSheet string
The ID of the target sheet, taken from the link properties, to navigate to when opening the generated Analytics Application (empty for Analytics Application overview).
- templateApp stringRequired
The system-assigned ID for an Analytics Application.
- actualRowEst integer
The evaluated value of the Link's
rowEstExprmeasure expression at the time this request was initiated. - errorMessage string
Detailed message if the request failed.
- generatedApp object
Condensed state of an Analytics Application returned in
statefor Link, LinkUsage, Request, and ODAG Apps GET calls.generatedApp properties
- id stringRequired
The system-assigned ID for an Analytics Application.
- name stringRequired
The name of an Analytics Application.
-
- modifiedDate stringRequired
- selectionApp string
The system-assigned ID for an Analytics Application.
- curRowEstExpr string
The Link's
rowEstExprproperty setting at the time this request was initiated. - retentionTime integer
The remaining time in minutes this request will be retained (0 means kept forever).
- parentRequestId string
The system-assigned ID for an ODAG request.
- templateAppName string
The name of an Analytics Application.
- bindingStateHash integer
A 64-bit hash of the bound field state at the time the request was made.
- generatedAppName string
The name of an Analytics Application.
- selectionAppName string
The name of an Analytics Application.
- curRowEstLowBound integer
The Link's
rowEstRange.lowBoundvalue for the user at the time this request was initiated. - curRowEstHighBound integer
The Link's
rowEstRange.highBoundvalue for the user at the time this request was initiated. - selectionStateHash integer
A 64-bit hash of the selected field values at the time the request was made.
-
403
Insufficient privilege to reload the generated Analytics Application. User must be either owner of the request or the ODAG link.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
404
Invalid request ID or generated Analytics Application not found.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.odagRequests.createOdagRequestReloadApp( 'string', { actualRowEst: 42, bindSelectionState: [ { selectedSize: 42, selectionAppParamName: 'string', selectionAppParamType: 'Field', values: [ { numValue: 'string', selStatus: 'S', strValue: 'string', }, ], }, ], copyRequest: true, selectionState: [ { selectedSize: 42, selectionAppParamName: 'string', selectionAppParamType: 'Field', values: [ { numValue: 'string', selStatus: 'S', strValue: 'string', }, ], }, ], },)qlik analytics odag-request reload-app 'string' \ --bindSelectionState-selectionAppParamName '' \ --bindSelectionState-selectionAppParamType '' \ --bindSelectionState-values-numValue '' \ --bindSelectionState-values-selStatus '' \ --bindSelectionState-values-strValue '' \ --selectionState-selectionAppParamName '' \ --selectionState-selectionAppParamType '' \ --selectionState-values-numValue '' \ --selectionState-values-selStatus '' \ --selectionState-values-strValue ''curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-requests/{requestId}/reload-app" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"copyRequest":true,"actualRowEst":42,"selectionState":[{"values":[{"numValue":"string","strValue":"string","selStatus":"S"}],"selectedSize":42,"selectionAppParamName":"string","selectionAppParamType":"Field"}],"bindSelectionState":[{"values":[{"numValue":"string","strValue":"string","selStatus":"S"}],"selectedSize":42,"selectionAppParamName":"string","selectionAppParamType":"Field"}]}'Example Response
{ "id": "string", "kind": "single", "link": "string", "owner": { "id": "wcgIs6wGcDdyzep9QmyopWvNH1FJTOhh", "name": "string", "subject": "string", "tenantid": "string" }, "state": "validating", "loadState": { "status": "pending", "loadHost": "string", "startedAt": "2025-11-11T13:45:30Z", "finishedAt": "2025-11-11T13:45:30Z" }, "sheetname": "string", "purgeAfter": "2025-11-11T13:45:30Z", "timeToLive": 42, "validation": [ "string" ], "createdDate": "2025-11-11T13:45:30Z", "targetSheet": "string", "templateApp": "string", "actualRowEst": 42, "errorMessage": "string", "generatedApp": { "id": "string", "name": "appname" }, "modifiedDate": "2025-11-11T13:45:30Z", "selectionApp": "string", "curRowEstExpr": "string", "retentionTime": 42, "parentRequestId": "string", "templateAppName": "appname", "bindingStateHash": 42, "generatedAppName": "appname", "selectionAppName": "appname", "curRowEstLowBound": 42, "curRowEstHighBound": 42, "selectionStateHash": 42}Renames a generated Analytics Application. Only the request owner or ODAG link creator can rename generated Analytics Applications.
Facts
| Rate limit | Tier 2 (100 requests per minute) |
Path Parameters
- requestId stringRequired
The ID of the request.
Request Body
Required- application/json object
Payload to send when renaming an Analytics Application generated by an ODAG request.
application/json properties
- appName stringRequired
The new name of the generated Analytics Application.
-
Responses
200
Successful response. Returns the updated request state.
- application/json object
The detailed content of an ODAG request object. If this is a summarization of a request initiated from a navigation point that has a single link, its
linkproperty refers to that link. Otherwise, a sub-request is created for each link in the navigation point and thelinkof each sub-request refers to its respective link. If this is asingleorsinglesubAnalytics Application generation request and the request has reached at least thequeuedstage, thegeneratedAppproperty contains the ID of the generated Analytics Application (note that the generated Analytics Application might not yet be populated with data or published if the request is not completed). If this is asingleorsinglesubrequest and the data load operation failed, thegeneratedAppproperty still contains the ID of the failed Analytics Application to allow viewing of the ODAG-bound script for diagnostic purposes. Generated Analytics Applications for failed requests are purged regularly, so the Analytics Application might no longer be available. If this is asingleorsinglesubrequest that was canceled before reaching theloadingphase, thegeneratedAppproperty is missing because generated Analytics Applications for pre-load phase requests are deleted. If this is amultiplerequest, thegeneratedAppproperty is also missing.application/json properties
- id stringRequired
The system-assigned ID for an ODAG request.
- kind stringRequired
For links that do not use any partitioning fields, a
singleAnalytics Application generation request is created. However, for selection Analytics Applications that designate a set of partitioning fields and the user selects multiple values for any of those partitioning fields, ODAG uses a separatesinglesubrequest to generate a separate Analytics Application for each combination of selected partition field values, and tracks the queuing and data load phase of each of those sub-requests separately. Note thatsinglesubrequests share the same link ID as their spawningmultipleparent request.Can be one of: "single""multiple""singlesub"
- link stringRequired
The system-assigned ID for a link.
- owner objectRequired
Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request).
owner properties
- id stringRequired
The system-assigned ID for a user
- name stringRequired
- subject stringRequired
Identity subject used for identity mapping.
- tenantid stringRequired
Tenant identifier.
-
- state stringRequired
The current state of an ODAG request.
Can be one of: "validating""queued""invalid""hold""loading""canceled""failed""succeeded""canceling""canceledAck""failedAck"
- loadState object
An object that describes the state of a generated Analytics Application's data load operation. In request objects that include this object as an optional property, the property will be missing for
multiplegeneration requests (see their sub-requests for their data load information) or forsingleandsinglesubrequests that have not yet reached theirloadingphase.loadState properties
- status string
The completion status of a completed Request.
Can be one of: "pending""success""warnings""failed"
- loadHost stringRequired
The engine host name used to perform the data load operation for this request. This property will be missing in
multiplegeneration requests (see theloadHostfield of their sub-requests) and will be an empty string on asingleorsinglesubrequest that has not yet reached theloadingphase. - startedAt stringRequired
- finishedAt string
-
- sheetname string
- purgeAfter string
- timeToLive integer
The value of the Link's
appRetentionTimeproperty at the time the Analytics Application was generated (0means no auto-purge). - validation array of strings
A list of validation errors or warnings.
- createdDate stringRequired
- targetSheet string
The ID of the target sheet, taken from the link properties, to navigate to when opening the generated Analytics Application (empty for Analytics Application overview).
- templateApp stringRequired
The system-assigned ID for an Analytics Application.
- actualRowEst integer
The evaluated value of the Link's
rowEstExprmeasure expression at the time this request was initiated. - errorMessage string
Detailed message if the request failed.
- generatedApp object
Condensed state of an Analytics Application returned in
statefor Link, LinkUsage, Request, and ODAG Apps GET calls.generatedApp properties
- id stringRequired
The system-assigned ID for an Analytics Application.
- name stringRequired
The name of an Analytics Application.
-
- modifiedDate stringRequired
- selectionApp string
The system-assigned ID for an Analytics Application.
- curRowEstExpr string
The Link's
rowEstExprproperty setting at the time this request was initiated. - retentionTime integer
The remaining time in minutes this request will be retained (0 means kept forever).
- parentRequestId string
The system-assigned ID for an ODAG request.
- templateAppName string
The name of an Analytics Application.
- bindingStateHash integer
A 64-bit hash of the bound field state at the time the request was made.
- generatedAppName string
The name of an Analytics Application.
- selectionAppName string
The name of an Analytics Application.
- curRowEstLowBound integer
The Link's
rowEstRange.lowBoundvalue for the user at the time this request was initiated. - curRowEstHighBound integer
The Link's
rowEstRange.highBoundvalue for the user at the time this request was initiated. - selectionStateHash integer
A 64-bit hash of the selected field values at the time the request was made.
-
403
Insufficient privilege to rename the generated Analytics Application. User must be either owner of the request or the ODAG link.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
404
Invalid request ID or generated Analytics Application not found.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.odagRequests.createOdagRequestRenameApp( 'string', { appName: 'string' },)qlik analytics odag-request rename-app 'string' \ --appName 'string'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-requests/{requestId}/rename-app" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"appName":"string"}'Example Response
{ "id": "string", "kind": "single", "link": "string", "owner": { "id": "wcgIs6wGcDdyzep9QmyopWvNH1FJTOhh", "name": "string", "subject": "string", "tenantid": "string" }, "state": "validating", "loadState": { "status": "pending", "loadHost": "string", "startedAt": "2025-11-11T13:45:30Z", "finishedAt": "2025-11-11T13:45:30Z" }, "sheetname": "string", "purgeAfter": "2025-11-11T13:45:30Z", "timeToLive": 42, "validation": [ "string" ], "createdDate": "2025-11-11T13:45:30Z", "targetSheet": "string", "templateApp": "string", "actualRowEst": 42, "errorMessage": "string", "generatedApp": { "id": "string", "name": "appname" }, "modifiedDate": "2025-11-11T13:45:30Z", "selectionApp": "string", "curRowEstExpr": "string", "retentionTime": 42, "parentRequestId": "string", "templateAppName": "appname", "bindingStateHash": 42, "generatedAppName": "appname", "selectionAppName": "appname", "curRowEstLowBound": 42, "curRowEstHighBound": 42, "selectionStateHash": 42}Retrieves the selection state (selected and optional field values) that was active when the Analytics Application generation request was submitted.
Facts
| Rate limit | Tier 1 (1000 requests per minute) |
Path Parameters
- requestId stringRequired
The ID of the request.
Responses
200
Successful response.
- application/json array of objects
A collection of FieldSelectionStateV2 objects.
application/json properties
- values array of objectsRequired
The list of values in the selection state for this field.
values properties
- numValue string
- strValue stringRequired
- selStatus stringRequired
The valid set of selection states that a specific field value can be in. One of:
S(selected),O(optional), orX(excluded).Can be one of: "S""O""X"
-
- selectedSize integer
The actual number of selected values. Not used for
bindSelectionState. - selectionAppParamName stringRequired
The name of a variable or field that corresponds to one or more bindings having a matching
selectAppParamNameused to generate Analytics Applications. - selectionAppParamType stringRequired
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
Excludeis 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).Can be one of: "Field""Variable""Property""Exclude""BDI"
-
403
Forbidden.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
404
Invalid request ID.
- application/json object
A standard error response containing a list of one or more errors.
application/json properties
- errors array of objects
A single error entry within an error response.
errors properties
- code string
A unique code used to identify the template form of the message in i18n tables (language independent).
- meta object
Additional metadata associated with an error.
meta properties
- statusCode integer
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.
-
- title string
- detail string
The message describing the error.
-
- traceId string
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.
-
import { createQlikApi } from '@qlik/api'
const qlik = createQlikApi({ hostConfig: { host: 'https://{tenant}.{region}.qlikcloud.com', apiKey: '<access-token>', },})
await qlik.analytics.odagRequests.getOdagRequestSelections( 'string',)qlik analytics odag-request selection ls 'string'curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/odag-requests/{requestId}/selections" \-H "Authorization: Bearer <access_token>"Example Response
[ { "values": [ { "numValue": "string", "strValue": "string", "selStatus": "S" } ], "selectedSize": 42, "selectionAppParamName": "string", "selectionAppParamType": "Field" }]