An app or an AI assistant acts as the person who connected it, so, as in Usertick, reading requires the View surveys and results permission, and writing a draft requires Manage dashboards and reports and the right to edit that board. Every draft written through the API appears in the activity log as made through the credential and uses no AI credits.
Who sees a new board
- A board an API key creates is shared with the organization and editable by everyone, so the key can read and change it later. Usertick names the key’s creator as the board’s creator.
- A board an app or an AI assistant creates is private to the person who connected it, as a new board in Usertick is. That person shares it from the dashboard.
404 with PUB-015-001.
The typed card
The API reads and writes every card in one shape:GET /dashboards/capabilities lists every kind with the fields it takes, which are required, their values and defaults, what the kind needs of a survey, and its default and smallest size. A field the kind doesn’t take returns 400 with PUB-015-002, and a kind the API doesn’t build returns PUB-015-006. A survey or a question the credential can’t read, or a question that isn’t in the survey, returns PUB-015-008. Each error names its field, such as cards[2].surveyId.
Create a dashboard
name (1 to 255 characters), description (up to 1,000), the tile’s icon and color keys (up to 40 each) and 0 to 500 cards. The call returns 201 with the draft, including its draftVersion, its cards and editorUrl, which opens the board in edit mode in Usertick. Give the person editorUrl so they can review and publish the board.
The plan’s limits on dashboards (403 with PLN-001-005) and cards per dashboard (PLN-001-013) apply as they do in the dashboard, and Usertick refuses a draft past the plan’s cards rather than cutting it. A board’s layout holds at most 128 KB, about 400 cards, and a request past that returns 400 with DSH-002-004.
Edit a draft
PATCH /dashboards/{dashboardId}/draft applies 1 to 50 operations in order, saved together or not at all:
- Send
expectedDraftVersionfrom the last read. If the draft changed since then, the edit returns409withPUB-015-004, and you need to read the draft again and redo the edit. - While the board is open in edit mode in Usertick, the edit returns
409withPUB-015-003. Ask the person to leave edit mode, then send the edit again. - A card ID that names no card returns
400withPUB-015-005, and fewer than 1 or more than 50 operations returnPUB-015-007. - You can edit a published board too. Its viewers keep the published board, and the answer says
hasUnpublishedChanges: trueuntil a person publishes or discards the draft. - A board shared with you as view only returns
403withDSH-006-003, and a board a plan change made read-only returns403withPLN-004-004. A board already past the plan’s cards per dashboard keeps saving as long as it doesn’t grow.