Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Analytics API

6 actions 6 updates phrasing extends openapi/canva-analytics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Canva's API. It is a proposal applied on top of the contract, not a document Canva publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/designs/{designId}/analytics'].get

$.paths['/v1/designs/{designId}/analytics/viewers'].get

$.paths['/v1/designs/{designId}/analytics/views-over-time'].get

$.paths['/v1/designs/{designId}/analytics/page-views'].post

$.paths['/v1/designs/{designId}/analytics/links'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canva Connect Analytics API
  version: 1.0.0
extends: openapi/canva-analytics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/designs/{designId}/analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overall view analytics for a design
      effect: read
      questions:
      - How many total views and unique viewers has my Canva design had?
      - What is the average view duration for a design I shared?
      - Can I get headline engagement numbers for one design in a single call?
      instructions:
      - text: Show the total views, unique viewers and view time for design {designId}.
        slots:
          designId: path.designId
      - text: Summarize the overall analytics for design {designId}.
        slots:
          designId: path.designId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/designs/{designId}/analytics/viewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the people who viewed a design
      effect: read
      questions:
      - Who has viewed my design, most recent first?
      - Can I see only the viewers who came through a particular tracked link?
      - Which viewers opened the design after a certain date?
      instructions:
      - text: List the viewers of design {designId}.
        slots:
          designId: path.designId
      - text: List who viewed design {designId} through link {link_id}.
        slots:
          designId: path.designId
          link_id: query.link_id
      - text: Show viewers of design {designId} who first viewed it after {first_viewed_after}.
        slots:
          designId: path.designId
          first_viewed_after: query.first_viewed_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/designs/{designId}/analytics/views-over-time'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart a design's views over time
      effect: read
      questions:
      - How have views on my design trended day by day?
      - Can I break a design's view counts into time buckets for a date range?
      - Is there a timezone setting for the view-count time series?
      instructions:
      - text: Show the view counts over time for design {designId}.
        slots:
          designId: path.designId
      - text: Get view counts for design {designId} between {start_time} and {end_time} in {timezone}.
        slots:
          designId: path.designId
          start_time: query.start_time
          end_time: query.end_time
          timezone: query.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/designs/{designId}/analytics/page-views'].post
  update:
    x-apievangelist-phrasing:
      intent: Get per-page view duration for a design
      effect: read
      questions:
      - Which pages of my presentation do viewers spend the most time on?
      - Can I get view duration broken down page by page for specific pages?
      - How long do people linger on each slide of a shared design?
      instructions:
      - text: Get page-level view time for pages {page_ids} of design {designId}.
        slots:
          page_ids: requestBody.page_ids
          designId: path.designId
      - text: Show how long viewers stayed on each of pages {page_ids} in design {designId}.
        slots:
          page_ids: requestBody.page_ids
          designId: path.designId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/designs/{designId}/analytics/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List trackable links for a design
      effect: read
      questions:
      - Which trackable share links exist for my design and how are they performing?
      - What metrics does each tracked link on a design report?
      - Can I compare engagement across the different links I sent out?
      instructions:
      - text: List the trackable links and their metrics for design {designId}.
        slots:
          designId: path.designId
      - text: Show the first {limit} tracked links for design {designId}.
        slots:
          limit: query.limit
          designId: path.designId
      method: generated
      generated: '2026-09-26'