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>

Gets the aggregated analytics for a design.

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

get/v1/designs/{designId}/analytics

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

Changed in 2 of the 8 revisions of this API.18

    • added the new design_generation_rejected enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new design_generation_rejected enum value to the code response property for the response status 401

      response-property-enum-value-added

    • added the new design_generation_rejected enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new design_generation_rejected enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new design_generation_rejected enum value to the code response property for the response status 429

      response-property-enum-value-added

    • added the new design_generation_rejected enum value to the code response property for the response status default

      response-property-enum-value-added

    • added the new domain_restricted enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new domain_restricted enum value to the code response property for the response status 401

      response-property-enum-value-added

    • added the new domain_restricted enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new domain_restricted enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new domain_restricted enum value to the code response property for the response status 429

      response-property-enum-value-added

    • added the new domain_restricted enum value to the code response property for the response status default

      response-property-enum-value-added

    • added the new user_already_member enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new user_already_member enum value to the code response property for the response status 401

      response-property-enum-value-added

    • added the new user_already_member enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new user_already_member enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new user_already_member enum value to the code response property for the response status 429

      response-property-enum-value-added

    • added the new user_already_member enum value to the code response property for the response status default

      response-property-enum-value-added