Preview JSON-LD

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the Schema.org markup Base44 generates from the app's entities, so you can see it before publishing it.

Base44 matches each entity to the Schema.org type its fields look most like, and leaves out any entity it can't match with reasonable confidence, so an app whose entities are all app-specific returns an empty list. Each entry carries the markup as a template: {field} placeholders name the entity fields, and Base44 injects the template into the page as it stands rather than filling it in per record.

Nothing here publishes the markup. Save the entries you want as custom_json_ld with Update SEO settings, and note that saving is not enough on its own. Base44 injects saved markup only into a page of a search-eligible app, with seo_disabled off and platform_jsonld_injection_enabled on. Base44 counts an app as search-eligible when it's public. A private or workspace app never is, and an app that requires a login qualifies only where Base44 has turned search indexing on for it. Check all three when markup you saved isn't on the page.

<Warning>Send confidence as a string, or leave it out, if you save these entries. The number this endpoint returns is stored as-is, and the copy of your settings that serves the live site can't hold a fractional number, so saving it that way stops that copy updating. Base44's own generator writes confidence as a string for the same reason.</Warning>

This endpoint is limited to 30 requests per minute per app, and that budget is shared with the app's other SEO endpoints.

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

get/api/apps/{app_id}/seo/preview/json-ld

Path parameters

app_idstring required

ID of the app.

ID of the app.

Response

The generated Schema.org markup.

Example response

{
  "result": {
    "entities": [
      {
        "confidence": 0.85,
        "entity_name": "Product",
        "field_mapping": {
          "name": "title"
        },
        "json_ld_template": {
          "@context": "https://schema.org",
          "@type": "Product",
          "name": "{title}"
        },
        "schema_type": "Product"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.