Sign in

v3

latestOpenAPI 3.0.0©2023 All Rights Reserved2026-08-0659315450.0 KB
analytics

<Warning>

This API is currently provided as a preview. Be aware of the following:

  • There might be unannounced breaking changes.
  • Any breaking changes to preview APIs won't produce a new API version.
  • Public integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.
</Warning> <Availability> To use this API, your integration must act on behalf of a user who is a member of a [Canva Enterprise](https://www.canva.com/enterprise/) organization. </Availability>

Lists viewers for a design, ordered by most recent view first.

get/v1/designs/{designId}/analytics/viewers

Path parameters

designIdstring required

The design ID.

Query parameters

link_idstring
Example:hddb98a3716

Filters viewers by a specific trackable link. If omitted, only viewers who visited the design without using a trackable link are returned.

first_viewed_afterinteger
Example:1745452800

Only returns viewers whose first view happened after this time, as a Unix timestamp (in seconds since the Unix Epoch).

limitinteger
Example:50

The maximum number of viewers to return per page.

continuationstring
Example:RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN

If the success response contains a continuation token, there are more viewers you can list. You can use this token as a query parameter and retrieve more viewers from the list, for example /v1/designs/{designId}/analytics/viewers?continuation={continuation}.

To retrieve all viewers, you might need to make multiple requests.

Response

OK

continuationstring

If the success response contains a continuation token, there are more viewers you can list. You can use this token as a query parameter and retrieve more viewers from the list, for example /v1/designs/{designId}/analytics/viewers?continuation={continuation}.

To retrieve all viewers, you might need to make multiple requests.

Example response

{
  "items": [
    {
      "viewer_id": "b2d44753-f996-46ff-8f01-d4143911550f",
      "user": {
        "user_id": "auDAbliZ2rQNNOsUl5OLu",
        "team_id": "Oi2RJILTrKk0KRhRUZozX",
        "display_name": "Jane Doe"
      },
      "last_viewed_at": 1748044800,
      "total_view_duration_seconds": 312,
      "first_viewed_at": 1745452800,
      "pages_viewed": 8,
      "device_operating_system": "macOS",
      "city_country": "Sydney, Australia",
      "total_view_count": 14
    }
  ],
  "continuation": "RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN"
}