> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# getDesignMetadata

API reference for the getDesignMetadata method.

Retrieves information about the design.

## Usage: Get design metadata

```typescript
import { getDesignMetadata } from "@canva/design";

const metadata = await getDesignMetadata();

const { title, defaultPageDimensions,  pageMetadata, durationInSeconds } = metadata;
```

## Returns

Information about the design. This is a `Promise` that resolves with the following object:

<Prop.List>
  <Prop name="pageMetadata" required type="Iterable<PageMetadata>" sourceLineNumbers={[3362]}>
    The information associated with each page of the design.

    The order of pages is not guaranteed.

    <Tabs>
      <Tab name="AbsolutePageMetadata">
        Information about a page within a design with fixed or unbounded dimensions.

        <Prop.List>
          <Prop name="type" required type="string" sourceLineNumbers={[9]}>
            The type of page.

            The only valid value is `"absolute"`.
          </Prop>

          <Prop name="id" type="PageId" sourceLineNumbers={[13]}>
            Stable identifier for this page within the design.
          </Prop>

          <Prop name="dimensions" type="PageDimensions" sourceLineNumbers={[20]}>
            The dimensions of the page, in pixels.

            This may be `undefined` because some types of pages don't have dimensions, such as whiteboards.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>dimensions</strong></>}>
              <Prop.List>
                <Prop name="width" required type="number" sourceLineNumbers={[5217]}>
                  The width of the page, in pixels.
                </Prop>

                <Prop name="height" required type="number" sourceLineNumbers={[5221]}>
                  The height of the page, in pixels.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>

          <Prop name="title" type="string" sourceLineNumbers={[26]}>
            The name of the page.

            This is optional and will be empty if the user hasn't set a title.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="UnsupportedPageMetadata">
        Pages that do not have fixed or unbounded dimensions currently do not return metadata.

        <Prop.List>
          <Prop name="type" required type="string" sourceLineNumbers={[6672]}>
            The type of page.

            The only valid value is `"unsupported"`.
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </Prop>

  <Prop name="durationInSeconds" required type="number" sourceLineNumbers={[3368]}>
    The duration of the whole design in seconds.

    This is the precise value, which differs from what is displayed in the UI as duration in Canva UI is formatted differently.
  </Prop>

  <Prop name="title" type="string" sourceLineNumbers={[3347]}>
    The title of the user's design.

    This is optional and will be `undefined` if the user hasn't set a title.
  </Prop>

  <Prop name="defaultPageDimensions" type="PageDimensions" sourceLineNumbers={[3356]}>
    The default dimensions that a new page will have when it is added to a design.
    It is possible for a user to resize a page without resizing the entire design, e.g. by clicking
    "Expand to Whiteboard". However, there will always be a single set of default dimensions for a
    design that is applied whenever a new page is created.

    This is optional and will be `undefined` if the design is unbounded (e.g. Whiteboard or Doc).

    <PillAccordion defaultExpanded={false} title={<>Properties of <strong>defaultPageDimensions</strong></>}>
      <Prop.List>
        <Prop name="width" required type="number" sourceLineNumbers={[5217]}>
          The width of the page, in pixels.
        </Prop>

        <Prop name="height" required type="number" sourceLineNumbers={[5221]}>
          The height of the page, in pixels.
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>

  <Prop name="dataset" type="DataField[]" sourceLineNumbers={[3374]}>
    The set of data fields that were tagged for Autofill.

    This field might be undefined or empty to represent a design that has no tagged fields.

    <PillAccordion defaultExpanded={false} title={<>Properties of <strong>dataset</strong></>}>
      <Prop.List>
        <Prop name="type" required type="string" sourceLineNumbers={[1498]}>
          <Prop.Extras>
            **Available values**:

            * `"image"`
            * `"text"`
            * `"chart"`
          </Prop.Extras>
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>
</Prop.List>

## Permissions

To use this method, the `canva:design:content:read` permission must be enabled for the app. To learn more, see [Permissions](https://www.canva.dev/docs/apps/configuring-intents-permissions/).