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>

Gets the aggregated analytics for a design.

The response includes total views, unique viewers, and view duration metrics.

get/v1/designs/{designId}/analytics

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/designs/{designId}/analytics
  • 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.

Response

OK

average_view_duration_secondsinteger

The average view duration in seconds.

total_view_duration_secondsinteger

The total view duration in seconds.

unique_view_countinteger required

The number of unique viewers.

total_view_countinteger required

The total number of views.

Example response

{
  "average_view_duration_seconds": 42,
  "total_view_duration_seconds": 5040,
  "unique_view_count": 87,
  "total_view_count": 120
}

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