Obtener metadatos del sitio web

api-referenceGET

GEThttps://analytics.flowsery.com/analytics/api/v1/metadata

Obtener los metadatos de configuracion de su sitio web.

Token Bearer (token de workspace o clave API de sitio web)

Los tokens de espacio de trabajo necesitan un selector de sitio web

Los tokens de API del espacio de trabajo pueden acceder a todos los sitios web del espacio de trabajo. Pase <code>websiteId</code> o <code>domain</code> para que Flowsery sepa qué sitio web consultar o mutar. Las claves API del sitio web ya están destinadas a un sitio web, por lo que se puede omitir el selector.

Selector de sitios web

Parametro	Tipo	Descripcion
`websiteId`	`string`	ID del sitio web para usar con un token de API del espacio de trabajo. Omitir al autenticarse con una clave API de sitio web.
`domain`	`string`	Sitio web domain para usar con un token API de espacio de trabajo cuando no se proporciona websiteId. Omitir al autenticarse con una clave API de sitio web.

Campos de respuesta

Parametro	Tipo	Descripcion
`domain`	`string`	El dominio del sitio web.
`timezone`	`string`	Identificador de zona horaria IANA para el sitio (por ejemplo, "America/New_York", "UTC").
`name`	`string`	Nombre de visualizacion personalizado para el sitio web.
`logo`	`string \| null`	URL del logotipo personalizado del sitio, o null cuando no se ha establecido ninguno.
`kpiColorScheme`	`string`	Esquema de color utilizado para las visualizaciones de KPI. Valores posibles: red, orange, yellow, green, purple, pink, gray, blue, teal, indigo.
`kpi`	`string \| null`	El nombre del objetivo/evento personalizado designado como indicador clave de rendimiento para este sitio.
`currency`	`string`	Codigo de moneda (por ejemplo, "USD", "EUR", "GBP").

Solicitud de ejemplo (curl)

curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/metadata \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "domain": "example.com",
      "timezone": "America/New_York",
      "name": "My Awesome Website",
      "logo": "https://d1aebdcemlt4l7.cloudfront.net/website-logos/xK9mPq2bR7nYwJ3vL5tA.png",
      "kpiColorScheme": "orange",
      "kpi": "signup",
      "currency": "USD"
    }
  ]
}