Brand Studio docs
Engineering manualSchema reference

Brand Studio client social media context

Declared schema: schemas/client-social-media.schema.json

Source: schemas/client-social-media.schema.json. This is the complete declaration, including nested definitions and constraints. Its presence is not evidence that a runtime producer or consumer validates against it.

All schemas · Data structures and lineage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://brand.mirrorfactory.ai/schemas/client-social-media.schema.json",
  "title": "Brand Studio client social media context",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schema_version",
    "status",
    "brand",
    "capture_context",
    "summary",
    "platforms",
    "safe_claim",
    "limitations",
    "source_manifest"
  ],
  "properties": {
    "schema_version": {
      "const": "brand-studio-client-social-media/v1"
    },
    "status": {
      "enum": [
        "captured",
        "partial_authentication_required"
      ]
    },
    "brand": {
      "type": "object",
      "required": [
        "name",
        "official_website"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "official_website": {
          "type": "string"
        }
      }
    },
    "capture_context": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "evidence_state",
        "freshness",
        "captured_at_earliest",
        "captured_at_latest"
      ],
      "properties": {
        "evidence_state": {
          "type": "string"
        },
        "freshness": {
          "enum": [
            "captured_state",
            "recorded_capture_window_not_current"
          ]
        },
        "captured_at_earliest": {
          "type": [
            "string",
            "null"
          ]
        },
        "captured_at_latest": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "summary": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "supported_platforms",
        "accepted_platforms",
        "authentication_required_platforms",
        "accepted_records",
        "accepted_source_records",
        "paid_provider_used",
        "monetary_spend_usd",
        "complete_archive_claimed"
      ],
      "properties": {
        "supported_platforms": {
          "type": "integer",
          "minimum": 0
        },
        "accepted_platforms": {
          "type": "integer",
          "minimum": 0
        },
        "authentication_required_platforms": {
          "type": "integer",
          "minimum": 0
        },
        "accepted_records": {
          "type": "integer",
          "minimum": 0
        },
        "accepted_source_records": {
          "type": "integer",
          "minimum": 0
        },
        "paid_provider_used": {
          "type": "boolean"
        },
        "monetary_spend_usd": {
          "type": "number",
          "minimum": 0
        },
        "complete_archive_claimed": {
          "type": "boolean"
        }
      }
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "platform",
          "official_profile",
          "state",
          "accepted_records",
          "accepted_source_records",
          "routes",
          "representative_records",
          "claim_boundary",
          "lineage"
        ],
        "properties": {
          "platform": {
            "type": "string"
          },
          "official_profile": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "accepted_records": {
            "type": "integer",
            "minimum": 0
          },
          "accepted_source_records": {
            "type": "integer",
            "minimum": 0
          },
          "routes": {
            "type": "array"
          },
          "representative_records": {
            "type": "array"
          },
          "claim_boundary": {
            "type": "string"
          },
          "lineage": {
            "type": "object",
            "required": [
              "source_run_id",
              "capture_sha256",
              "package_capture_sha256",
              "package_capture_path"
            ]
          }
        }
      }
    },
    "safe_claim": {
      "type": "string"
    },
    "limitations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1
    },
    "source_manifest": {
      "type": "object",
      "required": [
        "package_path",
        "sha256",
        "generated_at"
      ]
    }
  }
}