---
title: "Fetch Webchat Blog Metadata"
method: POST
path: "/webchat/blogs/fetch-metadata"
tags: ["Web Chat"]
---

# Fetch Webchat Blog Metadata

`POST /webchat/blogs/fetch-metadata`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/webchat/blogs/fetch-metadata`
- Auth: HTTP bearer

Read a page's Open Graph metadata, to pre-fill an article card.

Fetches the URL and returns its `og:title`, `og:description` and
`og:image`. PERSISTS NOTHING and spends nothing - create the card with
`POST /webchat/blogs` afterwards.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- BlogMetadataRequest: A URL to read Open Graph metadata from. Persists NOTHING. It fetches the page and returns its `og:title`, `og:description` and `og:image` so a caller can pre-fill an article card instead of typing it - which is why it is tiered a read despite the verb.
  - `url` string, required: Page to read og:title / og:description / og:image from.

## Response `200`

Successful Response

- ApiResponseWebchatPayload
  - `data` WebchatPayload, required: An open envelope for one webchat object. Open because the widget's config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)