Open Graph

Open Graph metadata for social sharing.

get

Responses

200

Returns OpenGraph default value

application/json

idstringRequired

typestringRequired

urlstringRequired

titlestringRequired

descriptionstringRequired

siteNamestringRequired

localestringRequired

updatedTimestringRequired

imagestringRequired

videostring · nullableRequired

get/open-graph

GET /apis/v2/open-graph HTTP/1.1
Accept: */*

200

Returns OpenGraph default value

{
  "id": "text",
  "type": "text",
  "url": "text",
  "title": "text",
  "description": "text",
  "siteName": "text",
  "locale": "text",
  "updatedTime": "text",
  "image": "text",
  "video": "text",
  "event": {
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z"
  }
}

get

Path parameters

replayIdstringRequiredExample: 3857358a-59e8-4944-8c48-3345c4375b43

Responses

200

Returns an OpenGraph replay

application/json

idstringRequired

typestringRequired

urlstringRequired

titlestringRequired

descriptionstringRequired

siteNamestringRequired

localestringRequired

updatedTimestringRequired

imagestringRequired

videostring · nullableRequired

get/open-graph/replays/{replayId}

GET /apis/v2/open-graph/replays/{replayId} HTTP/1.1
Accept: */*

200

Returns an OpenGraph replay

{
  "id": "text",
  "type": "text",
  "url": "text",
  "title": "text",
  "description": "text",
  "siteName": "text",
  "locale": "text",
  "updatedTime": "text",
  "image": "text",
  "video": "text",
  "event": {
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z"
  }
}

get

Path parameters

eventIdstringRequiredExample: 3857358a-59e8-4944-8c48-3345c4375b43

Responses

200

Returns a OpenGraph

application/json

idstringRequired

typestringRequired

urlstringRequired

titlestringRequired

descriptionstringRequired

siteNamestringRequired

localestringRequired

updatedTimestringRequired

imagestringRequired

videostring · nullableRequired

get/open-graph/events/{eventId}

GET /apis/v2/open-graph/events/{eventId} HTTP/1.1
Accept: */*

200

Returns a OpenGraph

{
  "id": "text",
  "type": "text",
  "url": "text",
  "title": "text",
  "description": "text",
  "siteName": "text",
  "locale": "text",
  "updatedTime": "text",
  "image": "text",
  "video": "text",
  "event": {
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z"
  }
}

get

Path parameters

seriesIdstringRequiredExample: 3857358a-59e8-4944-8c48-3345c4375b43

Responses

200

Returns a OpenGraph

application/json

idstringRequired

typestringRequired

urlstringRequired

titlestringRequired

descriptionstringRequired

siteNamestringRequired

localestringRequired

updatedTimestringRequired

imagestringRequired

videostring · nullableRequired

get/open-graph/series/{seriesId}

GET /apis/v2/open-graph/series/{seriesId} HTTP/1.1
Accept: */*

200

Returns a OpenGraph

{
  "id": "text",
  "type": "text",
  "url": "text",
  "title": "text",
  "description": "text",
  "siteName": "text",
  "locale": "text",
  "updatedTime": "text",
  "image": "text",
  "video": "text",
  "event": {
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z"
  }
}

get

Path parameters

sharingKeystringRequiredExample: K4RPxVwL0k

Responses

200

Returns a OpenGraph

application/json

idstringRequired

typestringRequired

urlstringRequired

titlestringRequired

descriptionstringRequired

siteNamestringRequired

localestringRequired

updatedTimestringRequired

imagestringRequired

videostring · nullableRequired

get/open-graph/events/invitations/{sharingKey}

GET /apis/v2/open-graph/events/invitations/{sharingKey} HTTP/1.1
Accept: */*

200

Returns a OpenGraph

{
  "id": "text",
  "type": "text",
  "url": "text",
  "title": "text",
  "description": "text",
  "siteName": "text",
  "locale": "text",
  "updatedTime": "text",
  "image": "text",
  "video": "text",
  "event": {
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z"
  }
}

get

Path parameters

orderIdstringRequiredExample: 3857358a-59e8-4944-8c48-3345c4375b43

Responses

200

Returns a OpenGraph

application/json

idstringRequired

typestringRequired

urlstringRequired

titlestringRequired

descriptionstringRequired

siteNamestringRequired

localestringRequired

updatedTimestringRequired

imagestringRequired

videostring · nullableRequired

get/open-graph/orders/{orderId}

GET /apis/v2/open-graph/orders/{orderId} HTTP/1.1
Accept: */*

200

Returns a OpenGraph

{
  "id": "text",
  "type": "text",
  "url": "text",
  "title": "text",
  "description": "text",
  "siteName": "text",
  "locale": "text",
  "updatedTime": "text",
  "image": "text",
  "video": "text",
  "event": {
    "startTime": "2026-01-01T00:00:00.000Z",
    "endTime": "2026-01-01T00:00:00.000Z"
  }
}