Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Frontend Modules

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

# About the Site Info API

The Site Info API tells you the display name, revision number, and ID of the site your code runs on. Use it to show the site's name to site visitors, or to tag your own error reports with the site's revision.

With the Site Info API, you can:

- Retrieve the site's display name.
- Retrieve the site's revision number.
- Retrieve the site's ID.

## Use cases

- [Show the site name in a footer](resourceId::ed3b87ef-2c42-45a4-a014-8f4a0d80a9b6#show-the-site-name-in-a-footer*fallback::https://github.com/wix-private/developer-docs/blob/b2b0c3adb46d31001b40fc373e317475c40f322c/docs-from-typedoc/site-service-site-info/site-info/sample-flows.md#show-the-site-name-in-a-footer*original::./sample-flows.md#show-the-site-name-in-a-footer)
- [Tag error reports with the site revision](resourceId::ed3b87ef-2c42-45a4-a014-8f4a0d80a9b6#tag-error-reports-with-the-site-revision*fallback::https://github.com/wix-private/developer-docs/blob/b2b0c3adb46d31001b40fc373e317475c40f322c/docs-from-typedoc/site-service-site-info/site-info/sample-flows.md#tag-error-reports-with-the-site-revision*original::./sample-flows.md#tag-error-reports-with-the-site-revision)

## Terminology

- **Revision**: A saved or published version of the site, as listed in its [site history](fallback::https://support.wix.com/en/article/viewing-and-managing-your-site-history).

## SDK setup

@package_metadata:@wix/site-service-site-info

To use the API, install the `@wix/site-service-site-info` package:

```bash
npm install @wix/site-service-site-info
```

#### Import the package

```ts
import { SiteInfoDefinition } from '@wix/site-service-site-info/definition'
```

#### Resolve the service

In a React component, resolve the service with the `useService` hook:

```tsx
import { useService } from '@wix/services-manager-react'
import { SiteInfoDefinition } from '@wix/site-service-site-info/definition'

function SiteName() {
    const siteInfoService = useService(SiteInfoDefinition)

    return <span>{siteInfoService.name}</span>
}
```