Organisations
How often a diagram's embed links were shown, by website
The last 30 days, by link and website: shown, and placeholders.
GET
/orgs/{org}/diagrams/{id}/embed-links/viewsTL;DR
| Question | Answer |
|---|---|
| What does it do? | How often a diagram's embed links were shown, by website. |
| What does it take? | org, id in the path. |
| What does it return? | Status 200 with a body of type EmbedLinkViews. |
| What can go wrong? | 401 not signed in; 403 the role may not manage the diagram's links; 404 no such organisation, diagram or link, or the caller is not a member, or the diagram is in a folder the caller may not use; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The last 30 days, by link and website: shown, and placeholders. Only the host of the page and the day are kept.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The views. | EmbedLinkViews |
| 401 | Not signed in. | ErrorResponse |
| 403 | The role may not manage the diagram's links. | ErrorResponse |
| 404 | No such organisation, diagram or link, or the caller is not a member, or the diagram is in a folder the caller may not use. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type EmbedLinkViews.
| Field | Type | Required | Description |
|---|---|---|---|
available | boolean | yes | False when views are not set up on this server or could not be read now. |
days | integer | yes | |
links | object[] | yes | |
links[].linkId | string | yes | |
links[].diagramId | string | yes | |
links[].label | string | null | yes | |
links[].shown | integer | yes | |
links[].refused | integer | yes | |
links[].sites | object[] | yes | |
links[].sites[].site | string | yes | The host of the page that asked, or empty for requests that named no page. |
links[].sites[].shown | integer | yes | |
links[].sites[].refused | integer | yes | Placeholders: a site not on the list, no site named, or an ended link. |
links[].sites[].lastDay | string | yes | The last UTC day it asked, YYYY-MM-DD. |
links[].days | object[] | yes | |
links[].days[].day | string | yes | |
links[].days[].shown | integer | yes | |
links[].days[].refused | integer | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |