V2 Displays

List displays (v2)

get

Returns a compact display list with revision tokens for optimistic concurrency.

Responses

200

Display list retrieved successfully

application/json

401

Unauthorized

application/json

get

/api/v2/displays

HTTPcURLJavaScriptPython

GET /api/v2/displays HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "variableCount": 1,
    "widgetCount": 1,
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "revision": "text"
  }
]

Get display (v2)

get

Path parameters

displayIdstring · uuidRequired

Responses

200

Display retrieved successfully

application/json

401

Unauthorized

application/json

404

Display not found

application/json

get

/api/v2/displays/{displayId}

HTTPcURLJavaScriptPython

GET /api/v2/displays/{displayId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "variables": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "widgets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "originResourceId": "123e4567-e89b-12d3-a456-426614174000",
      "isOriginSubSchema": true,
      "viewConfigId": "123e4567-e89b-12d3-a456-426614174000",
      "viewConfig": {
        "id": "text",
        "name": "text",
        "type": "text",
        "default": true,
        "erasable": true,
        "fields": [
          "text"
        ],
        "filters": null,
        "order": null,
        "columnSize": null,
        "groupsExpanded": null,
        "additionalProperties": null,
        "hierarchyConfig": {
          "columns": {
            "label": "text",
            "infos": [
              {
                "id": "text",
                "name": "text"
              }
            ],
            "numbers": [
              {
                "id": "text",
                "name": "text",
                "aggregation": "COUNT"
              }
            ]
          },
          "rootLevel": {
            "name": "text",
            "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "infoMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "numberMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          },
          "childLevels": [
            {
              "name": "text",
              "schemaId": "123e4567-e89b-12d3-a456-426614174000",
              "childFieldId": "123e4567-e89b-12d3-a456-426614174000",
              "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
              "infoMappings": [
                {
                  "columnId": "text",
                  "fieldId": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "numberMappings": [
                {
                  "columnId": "text",
                  "fieldId": "123e4567-e89b-12d3-a456-426614174000"
                }
              ]
            }
          ]
        }
      },
      "type": "TABLE_OR_SUBTABLE",
      "variableMap": {
        "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
      },
      "typeCalc": "COUNT",
      "fieldCalc": "123e4567-e89b-12d3-a456-426614174000",
      "xAxisFieldId": "123e4567-e89b-12d3-a456-426614174000",
      "xAxisDateFormat": "DATE",
      "xAxisAsTimeSerie": true,
      "yAxisSeries": [
        {
          "typeCalc": "COUNT",
          "fieldCalc": "123e4567-e89b-12d3-a456-426614174000",
          "color": "text",
          "axisType": "PRIMARY"
        }
      ],
      "readOnly": true,
      "hideAddButton": true,
      "hideDeleteButton": true,
      "hideSortButton": true,
      "hideFilterButton": true,
      "hideSeeButton": true,
      "filters": [
        {
          "origin": {
            "schemaId": "123e4567-e89b-12d3-a456-426614174000",
            "fieldId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "target": {
            "schemaId": "123e4567-e89b-12d3-a456-426614174000",
            "fieldId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "comparisonOperator": "EQUAL",
          "values": [
            "text"
          ]
        }
      ],
      "layout": {
        "x": 1,
        "y": 2,
        "w": 8,
        "h": 5
      },
      "config": {
        "title": "Revenue Updated"
      }
    }
  ],
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "crossWidgetFilter": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "revision": "text"
}

Create widget (v2)

post

Creates a widget with a backend-generated widgetId. The current public contract patches raw widget properties via set/unset.

Path parameters

displayIdstring · uuidRequired

Body

application/json

Create widget request for API v2.

unsetstring[]Optional

Fields to unset on the new widget. Supported values today: layout and config..

clientRefstringOptional

Optional client correlation identifier echoed back in the mutation response.

expectedRevisionstringOptional

Optional optimistic concurrency token from the parent display.

Responses

200

Widget created successfully

application/json

400

Invalid widget payload

application/json

401

Unauthorized

application/json

409

Revision conflict

application/json

post

/api/v2/displays/{displayId}/widgets

HTTPcURLJavaScriptPython

POST /api/v2/displays/{displayId}/widgets HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "set": {
    "originResourceId": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
    "type": "KPI",
    "layout": {
      "x": 0,
      "y": 0,
      "w": 6,
      "h": 4
    },
    "config": {
      "title": "Revenue"
    }
  },
  "unset": [],
  "clientRef": "display-e2e",
  "expectedRevision": "77c2951c..."
}

{
  "displayId": "123e4567-e89b-12d3-a456-426614174000",
  "widgetId": "123e4567-e89b-12d3-a456-426614174000",
  "revision": "text",
  "clientRef": "text"
}

Get widget (v2)

get

Path parameters

displayIdstring · uuidRequired

widgetIdstring · uuidRequired

Responses

200

Widget retrieved successfully

application/json

401

Unauthorized

application/json

404

Widget not found

application/json

get

/api/v2/displays/{displayId}/widgets/{widgetId}

HTTPcURLJavaScriptPython

GET /api/v2/displays/{displayId}/widgets/{widgetId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "originResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "isOriginSubSchema": true,
  "viewConfigId": "123e4567-e89b-12d3-a456-426614174000",
  "viewConfig": {
    "id": "text",
    "name": "text",
    "type": "text",
    "default": true,
    "erasable": true,
    "fields": [
      "text"
    ],
    "filters": null,
    "order": null,
    "columnSize": null,
    "groupsExpanded": null,
    "additionalProperties": null,
    "hierarchyConfig": {
      "columns": {
        "label": "text",
        "infos": [
          {
            "id": "text",
            "name": "text"
          }
        ],
        "numbers": [
          {
            "id": "text",
            "name": "text",
            "aggregation": "COUNT"
          }
        ]
      },
      "rootLevel": {
        "name": "text",
        "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
        "infoMappings": [
          {
            "columnId": "text",
            "fieldId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "numberMappings": [
          {
            "columnId": "text",
            "fieldId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "childLevels": [
        {
          "name": "text",
          "schemaId": "123e4567-e89b-12d3-a456-426614174000",
          "childFieldId": "123e4567-e89b-12d3-a456-426614174000",
          "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
          "infoMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "numberMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        }
      ]
    }
  },
  "type": "TABLE_OR_SUBTABLE",
  "variableMap": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "typeCalc": "COUNT",
  "fieldCalc": "123e4567-e89b-12d3-a456-426614174000",
  "xAxisFieldId": "123e4567-e89b-12d3-a456-426614174000",
  "xAxisDateFormat": "DATE",
  "xAxisAsTimeSerie": true,
  "yAxisSeries": [
    {
      "typeCalc": "COUNT",
      "fieldCalc": "123e4567-e89b-12d3-a456-426614174000",
      "color": "text",
      "axisType": "PRIMARY"
    }
  ],
  "readOnly": true,
  "hideAddButton": true,
  "hideDeleteButton": true,
  "hideSortButton": true,
  "hideFilterButton": true,
  "hideSeeButton": true,
  "filters": [
    {
      "origin": {
        "schemaId": "123e4567-e89b-12d3-a456-426614174000",
        "fieldId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "target": {
        "schemaId": "123e4567-e89b-12d3-a456-426614174000",
        "fieldId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "comparisonOperator": "EQUAL",
      "values": [
        "text"
      ]
    }
  ],
  "layout": {
    "x": 1,
    "y": 2,
    "w": 8,
    "h": 5
  },
  "config": {
    "title": "Revenue Updated"
  }
}

Delete widget (v2)

delete

Path parameters

displayIdstring · uuidRequired

widgetIdstring · uuidRequired

Query parameters

expectedRevisionstringOptional

Responses

200

Widget deleted successfully

application/json

401

Unauthorized

application/json

404

Widget not found

application/json

409

Revision conflict

application/json

delete

/api/v2/displays/{displayId}/widgets/{widgetId}

HTTPcURLJavaScriptPython

DELETE /api/v2/displays/{displayId}/widgets/{widgetId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "displayId": "123e4567-e89b-12d3-a456-426614174000",
  "widgetId": "123e4567-e89b-12d3-a456-426614174000",
  "revision": "text",
  "clientRef": "text"
}

Patch widget (v2)

patch

Patches a widget using the current raw property-path contract. expectedRevision is optional but recommended.

Path parameters

displayIdstring · uuidRequired

widgetIdstring · uuidRequired

Body

application/json

Patch widget request for API v2.

unsetstring[]Optional

Fields to unset on the widget. Supported values today: layout and config..

expectedRevisionstringOptional

Optional optimistic concurrency token from the current widget/display snapshot.

Responses

200

Widget updated successfully

application/json

400

Invalid widget patch

application/json

401

Unauthorized

application/json

409

Revision conflict

application/json

patch

/api/v2/displays/{displayId}/widgets/{widgetId}

HTTPcURLJavaScriptPython

PATCH /api/v2/displays/{displayId}/widgets/{widgetId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "set": {
    "layout": {
      "x": 1,
      "y": 2,
      "w": 8,
      "h": 4
    },
    "config": {
      "title": "Revenue Updated"
    },
    "readOnly": true
  },
  "unset": [],
  "expectedRevision": "d3fce6..."
}

{
  "displayId": "123e4567-e89b-12d3-a456-426614174000",
  "widgetId": "123e4567-e89b-12d3-a456-426614174000",
  "revision": "text",
  "clientRef": "text"
}