Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# iframe Query Parameters for Dashboard Extensions

When a user accesses your self-hosted iframe dashboard extension through a client-side action, Wix provides you with the following query parameters:

```bash
[endpoint]?instance=[signed-instance-data]&locale=[locale]&cacheKiller=[cacheKiller]&viewMode=dashboard&isPublish=[isPublish]&containerProtocol=[httpProtocol]&siteUrl=[site-url]
```

| Name | Value | Comments |
|--|--|--|
| ```endpoint``` | The [Dashboard URL](portalId::299369f5-04da-4409-a0c7-b98870755002resourceId::7969e092-d8ea-48fd-bcdc-e601e2bacfdb*fallback::https://devforum.wix.com/kb/en/article/create-a-dashboard-page-component), as supplied when you registered your app in the Wix Dev Center. |
| ```instance``` | The [signed app instance](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/access/app-instances/about-app-instances). | The app instance ID (```instanceId```) is the unique identifier of your app within a specific user's website. |
| `locale` | Current local value. | This is the browser's language identified with two characters. For example, English = `en`. |
| ```cacheKiller``` | Ensures no caching of the iframe content by the host browser. | This is a randomly generated number to ensure the browser hasn't seen this URL before. |
| ```viewMode``` | Will only get 'dashboard' as it's an iframe dashboard extension. |
| ```isPublish``` | Boolean indicating if the site is published. |
| ```containerProtocol``` | Indicates if it's HTTP or HTTPS. |
| ```siteUrl``` | The address of the site to which the app belongs. | Relevant only if the site has already been published. |

Name	Value	Comments
`endpoint`	The Dashboard URL, as supplied when you registered your app in the Wix Dev Center.
`instance`	The signed app instance.	The app instance ID (`instanceId`) is the unique identifier of your app within a specific user's website.
`locale`	Current local value.	This is the browser's language identified with two characters. For example, English = `en`.
`cacheKiller`	Ensures no caching of the iframe content by the host browser.	This is a randomly generated number to ensure the browser hasn't seen this URL before.
`viewMode`	Will only get 'dashboard' as it's an iframe dashboard extension.
`isPublish`	Boolean indicating if the site is published.
`containerProtocol`	Indicates if it's HTTP or HTTPS.
`siteUrl`	The address of the site to which the app belongs.	Relevant only if the site has already been published.