Get SEO settings

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

Returns the app's saved SEO settings.

Only the keys you've actually saved appear in result, since it's the stored settings document itself rather than a computed view of them. An app whose SEO settings have never been changed returns an empty object, so treat a missing key as the default documented on that field rather than as unset.

Change them with Update SEO settings.

<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/settings

Path parameters

app_idstring required

ID of the app whose SEO settings you want.

Response

The app's saved SEO settings.

Example response

{
  "result": {
    "platform_meta_injection_enabled": true,
    "platform_jsonld_injection_enabled": true,
    "robots_txt_enabled": true,
    "sitemap_xml_enabled": true,
    "ai_crawlers_enabled": true,
    "synthesized_breadcrumb_enabled": true,
    "canonical_url": "https://acme.com",
    "content_query_params": [
      "article"
    ],
    "custom_json_ld": [
      {
        "confidence": "0.85",
        "entity_name": "Product",
        "field_mapping": {
          "name": "title"
        },
        "json_ld_template": {
          "@context": "https://schema.org",
          "@type": "Product",
          "name": "Acme CRM"
        },
        "schema_type": "Product"
      }
    ],
    "website_schema": {
      "@context": "https://schema.org",
      "@type": "WebSite",
      "name": "Acme CRM",
      "url": "https://acme.com"
    },
    "organization_schema": {
      "@context": "https://schema.org",
      "@type": "Organization",
      "name": "Acme",
      "url": "https://acme.com"
    },
    "breadcrumb_schema": {
      "@context": "https://schema.org",
      "@type": "BreadcrumbList",
      "itemListElement": []
    },
    "faq_schema": {
      "@context": "https://schema.org",
      "@type": "FAQPage",
      "mainEntity": []
    },
    "pages": {
      "Home": {
        "description": "Track leads and deals in one place.",
        "og_image": "https://cdn.example.com/acme-og.png",
        "title": "Acme CRM"
      }
    }
  }
}

Changes

No recorded changes to this endpoint across all 14 revisions of this API.