analytics

Changed on
<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 apps 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 app must act on behalf of a user who is a member of a [Canva Enterprise](https://www.canva.com/enterprise/) organization. </Availability>

Lists trackable links and their metrics for a design.

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

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/designs/{designId}/analytics/links
  • Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: design:content:read)

Path parameters

designIdstring required

The design ID.

Query parameters

limitinteger
Example:50

The maximum number of links to return per page.

continuationstring
Example:RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN

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

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

Response

OK

continuationstring

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

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

Example response

{
  "items": [
    {
      "link_id": "hddb98a3716",
      "name": "Newsletter link",
      "total_view_count": 64,
      "unique_view_count": 41,
      "total_view_duration_seconds": 2580,
      "average_view_duration_seconds": 40,
      "last_viewed_at": 1748044800
    }
  ],
  "continuation": "RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN"
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

  • 5ea5a3f48e72Revision changes
    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status