Change stores

Download specification

Get change-stores

Returns a list of change-stores, accessible to the user.

Facts

Rate limit Tier 1 (1000 requests per minute)

Header Parameters

  • Authorizationstring
    Required

    The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters

  • pagestring

    Used for cursor-based pagination.

  • limitinteger

    Defines the size of each paged result (maximum 100).

    maximum = 100

  • filterstring

    A SCIM filter expression used to filter the result. The filter parameter allows complex logical expressions using comparison operators and grouping.

    • Supported attributes: storeName, storeId, referenceId, usedBy.appId, primaryKey
    • Supported operators: eq, ne, co, sw, ew, pr, gt, ge, lt, le
    • Logical operators: and, or, not
  • sortstring

    Sort results by a field, with optional + (asc) or - (desc) prefix

    pattern = "^[+-]?(storeName)$"

  • spaceIdstring
    Required

    The space ID to filter change stores by. This parameter is required. For personal spaces, use "personal". For shared spaces, use the actual space ID, e.g. "690b584c5a8011de9079828e".

Responses

200

Returns a list of change stores.

  • application/jsonobject
    Show application/json properties
    • totalCountinteger
    • currentPageCountinteger
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
    • dataarray of objects
      Show data properties
      • usedByarray of objects

        List of chart/app references.

        Show usedBy properties
        • appIdstring
          Required

          The id of the app.

        • chartIdstring
          Required

          The id of the chart.
      • spaceIdstring

        The space id where the change store is located.

      • storeIdstring

        The id of the change store.

      • tenantIdstring

        The tenant id the change store belongs to.

      • createdAtstring

        The time when the change store was created.

        format = "date-time"

      • createdBystring

        The id of the user who created the change store.

      • storeNamestring

        The name of the change store.

      • updatedAtstring

        The time when the change store was last updated.

        format = "date-time"

      • primaryKeyarray of strings

        The list of primary key columns for the change store.

      • referenceIdstring

        The reference id used to identify related editable-columns or change stores.

      • publishRefIdstring

        The publish reference id used to map stores across published apps/spaces.

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring
GET /api/analytics/change-stores 
// qlik-api has not implemented support for `GET /api/analytics/change-stores` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/analytics/change-stores',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/change-stores" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "usedBy": [
        {
          "appId": "af604296-14f6-48c2-8bac-12ce49ba83cc",
          "chartId": "chartId"
        }
      ],
      "spaceId": "456",
      "storeId": "123",
      "tenantId": "tenant789",
      "storeName": "My Change Store",
      "primaryKey": [
        "product",
        "region"
      ],
      "publishRefId": "6835b0135cf7147c01979e5d"
    },
    {
      "usedBy": [
        {
          "appId": "af604296-14f6-48c2-8bac-12ce49ba83cc",
          "chartId": "chartId2"
        }
      ],
      "spaceId": "457",
      "storeId": "124",
      "tenantId": "tenant790",
      "storeName": "Another Change Store",
      "primaryKey": [
        "category",
        "region"
      ],
      "publishRefId": "6835b0135cf7147c01979e5d"
    }
  ],
  "links": {
    "next": {
      "href": "https://example.org/api/analytics/change-stores?page=2"
    },
    "prev": {
      "href": "https://example.org/api/analytics/change-stores?page=1"
    },
    "self": {
      "href": "https://example.org/api/analytics/change-stores?page=1"
    }
  },
  "totalCount": 10,
  "currentPageCount": 2
}

Get a change store

Returns detailed information about a specific change store, such as its configuration and associated charts.

Facts

Rate limit Tier 1 (1000 requests per minute)

Header Parameters

  • Authorizationstring
    Required

    The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Path Parameters

  • storeIdstring
    Required

    The id of the change store.

Responses

200

Returns a specific change store.

  • application/jsonobject
    Show application/json properties
    • dataobject
      Show data properties
      • usedByarray of objects

        List of chart/app references.

        Show usedBy properties
        • appIdstring
          Required

          The id of the app.

        • chartIdstring
          Required

          The id of the chart.
      • spaceIdstring

        The space id where the change store is located.

      • storeIdstring

        The id of the change store.

      • tenantIdstring

        The tenant id the change store belongs to.

      • createdAtstring

        The time when the change store was created.

        format = "date-time"

      • createdBystring

        The id of the user who created the change store.

      • storeNamestring

        The name of the change store.

      • updatedAtstring

        The time when the change store was last updated.

        format = "date-time"

      • primaryKeyarray of strings

        The list of primary key columns for the change store.

      • referenceIdstring

        The reference id used to identify related editable-columns or change stores.

      • publishRefIdstring

        The publish reference id used to map stores across published apps/spaces.

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring
GET /api/analytics/change-stores/{storeId} 
// qlik-api has not implemented support for `GET /api/analytics/change-stores/{storeId}` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/analytics/change-stores/{storeId}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/change-stores/{storeId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": {
    "usedBy": [
      {
        "appId": "af604296-14f6-48c2-8bac-12ce49ba83cc",
        "chartId": "chartId"
      }
    ],
    "spaceId": "456",
    "storeId": "123",
    "tenantId": "tenant789",
    "storeName": "My Change Store",
    "primaryKey": [
      "product",
      "region"
    ],
    "publishRefId": "6835b0135cf7147c01979e5d"
  }
}

Get changes

Returns a list of changes within the specified change-store.

Facts

Rate limit Tier 1 (1000 requests per minute)

Header Parameters

  • Authorizationstring
    Required

    The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters

  • pagestring

    Used for cursor-based pagination.

  • limitinteger

    Defines the size of each paged result (maximum 100).

    maximum = 100

  • filterstring

    A SCIM filter expression used to filter the result. The filter parameter allows complex logical expressions using comparison operators and grouping.

    • Supported attributes: committed, cellKey.columnId, columnId, createdBy, createdAt, updatedAt
    • Supported operators: eq, ne, co, sw, ew, pr, gt, ge, lt, le
    • Logical operators: and, or, not
  • sortstring

    Sort results by a field, with optional + (asc) or - (desc) prefix

    pattern = "^[+-]?(createdAt|updatedAt|cellKey)$"

Path Parameters

  • storeIdstring
    Required

    The id of the change store.

Responses

200

Changes response.

  • application/jsonobject
    Show application/json properties
    • totalCountinteger
    • currentPageCountinteger
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
    • dataarray of objects
      Show data properties
      • cellKeyobject
        Show cellKey properties
        • rowKeyobject
          Required

          A map of row keys.

          additional properties

        • columnIdstring
          Required

          The id of the column.
      • changesarray of objects
        Show changes properties
        • tenantIdstring

          The tenant id.

        • cellValuestring

          The value of the cell.

        • committedboolean

          Whether the change has been committed.

        • createdAtstring

          The time when a user starts typing in a cell and the row becomes locked.

          format = "date-time"

        • createdBystring

          The id of the user who created the change.

        • updatedAtstring

          The time when an update to the change has been done. Examples of when this value is updated:

          • User starts typing in a cell, locking the row.
          • User edits an unsaved change.
          • User saves the change.

          format = "date-time"

      • columnNamestring

        The name of the column.

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring
GET /api/analytics/change-stores/{storeId}/changes 
// qlik-api has not implemented support for `GET /api/analytics/change-stores/{storeId}/changes` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/analytics/change-stores/{storeId}/changes',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/change-stores/{storeId}/changes" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "totalCount": 10,
  "currentPageCount": 2,
  "links": {
    "next": {
      "href": "https://example.org/api/analytics/change-stores?page=<next-cursor>"
    },
    "prev": {
      "href": "https://example.org/api/analytics/change-stores?page=<previous-cursor>"
    },
    "self": {
      "href": "https://example.org/api/analytics/change-stores?page=<self-cursor>"
    }
  },
  "data": [
    {
      "cellKey": {
        "rowKey": {
          "product": "table"
        },
        "columnId": "690b5975fddd52c0fba8dd10"
      },
      "changes": [
        {
          "meta": {
            "tenantId": "tenant123",
            "createdAt": "2023-01-01T12:00:00Z",
            "createdBy": "user123"
          },
          "committed": true,
          "columnValue": "100"
        }
      ],
      "columnName": "price"
    }
  ]
}

Get rows in tabular view

Returns changes in tabular format, showing modified rows with optional expansion to include all columns.

Facts

Rate limit Tier 1 (1000 requests per minute)

Header Parameters

  • Authorizationstring
    Required

    The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters

  • expandRowboolean

    When set to true, the records returned by this endpoint will include the latest change (if available) for each editable column in the record. This parameter should be used in combination with a filter on updatedAt for use cases that require all editable columns to be included in each response.

  • pagestring

    Used for cursor-based pagination.

  • limitinteger

    Defines the size of each paged result (maximum 100).

    maximum = 100

  • filterstring

    A SCIM filter expression used to filter the result. The filter parameter allows complex logical expressions using comparison operators and grouping.

    • Supported attributes: committed, cellKey.columnId, columnId, createdBy, createdAt, updatedAt
    • Supported operators: eq, ne, co, sw, ew, pr, gt, ge, lt, le
    • Logical operators: and, or, not

Path Parameters

  • storeIdstring
    Required

    The id of the change store.

Responses

200

Returns change-store values in tabular format.

  • application/jsonobject
    Show application/json properties
    • totalCountinteger
    • currentPageCountinteger
    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring
      • prevobject
        Show prev properties
        • hrefstring
      • selfobject
        Show self properties
        • hrefstring
    • dataarray of objects
      Show data properties
      • updatedAtstring

        The timestamp when the row was last updated.

        format = "date-time"

      • updatedBystring

        The user id that performed the latest update in the row (corresponds to updatedAt).

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      list of errors

      Show errors properties
      • codestring
        Required

        The error code.

      • titlestring
        Required

        Description of the error.

      • detailstring

        Extra information about the error.
    • traceIdstring
GET /api/analytics/change-stores/{storeId}/changes/tabular-views 
// qlik-api has not implemented support for `GET /api/analytics/change-stores/{storeId}/changes/tabular-views` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/analytics/change-stores/{storeId}/changes/tabular-views',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
This API is not included yet in qlik-cli
curl "https://{tenant}.{region}.qlikcloud.com/api/analytics/change-stores/{storeId}/changes/tabular-views" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "totalCount": 10,
  "currentPageCount": 2,
  "links": {
    "next": {
      "href": "https://example.org/api/analytics/change-stores?page=<next-cursor>"
    },
    "prev": {
      "href": "https://example.org/api/analytics/change-stores?page=<previous-cursor>"
    },
    "self": {
      "href": "https://example.org/api/analytics/change-stores?page=<self-cursor>"
    }
  },
  "data": [
    {
      "updatedAt": "2023-10-01T12:00:00Z",
      "updatedBy": "abc123"
    }
  ]
}