Research und Briefings mit Quellenangaben

Übersicht eines ausgewählten Forschungskorpus lesen

Deterministische Zählwerte für einen genauen versiegelten Korpus lesen; ausgewählte Elemente sind keine Zielgruppen- oder Marktgröße. Erfordert agent:research.

POST /research-api/projects/overview

Vertrag geprüft: 2026-11-03 · sha256:ab393e91e9b7f18a

Als Markdown lesen Öffentlichen Vertrag herunterladen OpenAPI herunterladen

Überblick

Deterministische Zählwerte für einen genauen versiegelten Korpus lesen; ausgewählte Elemente sind keine Zielgruppen- oder Marktgröße. Erfordert agent:research.

Eine erfolgreiche HTTP-Antwort kann Annahme statt Abschluss bedeuten. Speichere bei Hintergrundarbeit die ID und prüfe dieselbe Operation bis zum Abschluss. Geplante oder angenommene Beiträge gelten erst nach Plattformbestätigung als veröffentlicht; ein Client-Timeout klärt das Ergebnis nicht.

Authentifizierung und Berechtigungen

Akzeptierte Zugangsdatenklassen: user_session, delegated_oauth, personal_access_token
Delegierte Funktion: agent:research
Minimale Workspace-Rolle: viewer
Zugriffsumfang: Ressourcen, auf die dieser Nutzer zugreifen darf
Zustimmung für alle Workspaces erforderlich: Nein
Ändert Zustand: Nein
Nach Abschluss der Operation: currently authorized exact Research resource data

Ein Token nutzt nur Eigentümerrechte. Jede Anfrage prüft Workspace-Mitgliedschaft, Ressourceneigentum, gewählte Workspaces und Funktionen. core und full ändern sichtbare Tools; sie erteilen keinen Zugriff.

Anfragefelder

Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.

Anfragefelder
Feld / Variante	Typ / erforderlich	Einschränkungen
`$`	`object`Im Elternobjekt erforderlich	`additionalProperties: false`
`workspace_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`project_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`project_revision`	`integer`Im Elternobjekt erforderlich	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`corpus_snapshot_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`

Vollständiges JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "project_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "corpus_snapshot_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "workspace_id",
    "project_id",
    "project_revision",
    "corpus_snapshot_id"
  ],
  "additionalProperties": false
}

Antwort und Abschluss

HTTP-Erfolgsstatus: 200. Wenn die Operation abgeschlossen ist: currently authorized exact Research resource data.

Antwort und Abschluss
Feld / Variante	Typ / erforderlich	Einschränkungen
`$`	`object`Im Elternobjekt erforderlich	—
`project_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`project_revision`	`integer`Im Elternobjekt erforderlich	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`corpus_snapshot_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`method_version`	`string`Im Elternobjekt erforderlich	`const: "literal-mentions/v1"`
`coverage`	`string`Im Elternobjekt erforderlich	`enum: ["supplied_set","bounded_sample","partial"]`
`evidence_count`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`unique_items`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`brand_union_count`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`overlap_count`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`brands`	`array`Im Elternobjekt erforderlich	`maxItems: 20`
`brands[]`	`object`Optional / Element	—
`brands[].id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`brands[].name`	`string`Im Elternobjekt erforderlich	`minLength: 1` `maxLength: 100`
`brands[].matched_items`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`brands[].observed_mention_share`	`number \| null`Im Elternobjekt erforderlich	—
`brands[].observed_mention_share`anyOf 1	`number`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 1`
`brands[].observed_mention_share`anyOf 2	`null`Im Elternobjekt erforderlich	—
`brands[].evidence`	`array`Im Elternobjekt erforderlich	`maxItems: 500`
`brands[].evidence[]`	`object`Optional / Element	—
`brands[].evidence[].evidence_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`brands[].evidence[].revision`	`integer`Im Elternobjekt erforderlich	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`languages`	`array`Im Elternobjekt erforderlich	`maxItems: 501`
`languages[]`	`object`Optional / Element	—
`languages[].language`	`string \| null`Im Elternobjekt erforderlich	—
`languages[].language`anyOf 1	`string`Im Elternobjekt erforderlich	`minLength: 1` `maxLength: 35`
`languages[].language`anyOf 2	`null`Im Elternobjekt erforderlich	—
`languages[].item_count`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`platforms`	`array`Im Elternobjekt erforderlich	`maxItems: 8`
`platforms[]`	`object`Optional / Element	—
`platforms[].platform`	`string \| null`Im Elternobjekt erforderlich	—
`platforms[].platform`anyOf 1	`string`Im Elternobjekt erforderlich	`enum: ["threads","instagram","facebook","youtube","x","reddit","web"]`
`platforms[].platform`anyOf 2	`null`Im Elternobjekt erforderlich	—
`platforms[].item_count`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`sources`	`array`Im Elternobjekt erforderlich	`maxItems: 3`
`sources[]`	`object`Optional / Element	—
`sources[].category`	`string`Im Elternobjekt erforderlich	`enum: ["your_accounts","public_posts","team_notes"]`
`sources[].item_count`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`history`	`object`Im Elternobjekt erforderlich	—
`history.eligible`	`boolean`Im Elternobjekt erforderlich	`const: false`
`history.reason`	`string`Im Elternobjekt erforderlich	`const: "insufficient_comparable_history"`

Vollständiges JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "project_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "project_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "corpus_snapshot_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "method_version": {
      "type": "string",
      "const": "literal-mentions/v1"
    },
    "coverage": {
      "type": "string",
      "enum": [
        "supplied_set",
        "bounded_sample",
        "partial"
      ]
    },
    "evidence_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "unique_items": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "brand_union_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "overlap_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "brands": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "matched_items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "observed_mention_share": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0,
                "maximum": 1
              },
              {
                "type": "null"
              }
            ]
          },
          "evidence": {
            "maxItems": 500,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "evidence_id": {
                  "type": "string",
                  "format": "uuid",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "evidence_id",
                "revision"
              ]
            }
          }
        },
        "required": [
          "id",
          "name",
          "matched_items",
          "observed_mention_share",
          "evidence"
        ]
      }
    },
    "languages": {
      "maxItems": 501,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 35
              },
              {
                "type": "null"
              }
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "language",
          "item_count"
        ]
      }
    },
    "platforms": {
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "platform": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "threads",
                  "instagram",
                  "facebook",
                  "youtube",
                  "x",
                  "reddit",
                  "web"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "platform",
          "item_count"
        ]
      }
    },
    "sources": {
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "enum": [
              "your_accounts",
              "public_posts",
              "team_notes"
            ]
          },
          "item_count": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "category",
          "item_count"
        ]
      }
    },
    "history": {
      "type": "object",
      "properties": {
        "eligible": {
          "type": "boolean",
          "const": false
        },
        "reason": {
          "type": "string",
          "const": "insufficient_comparable_history"
        }
      },
      "required": [
        "eligible",
        "reason"
      ]
    }
  },
  "required": [
    "project_id",
    "project_revision",
    "corpus_snapshot_id",
    "method_version",
    "coverage",
    "evidence_count",
    "unique_items",
    "brand_union_count",
    "overlap_count",
    "brands",
    "languages",
    "platforms",
    "sources",
    "history"
  ]
}

Fehler und sichere Wiederholungen

Prüfe HTTP-Status und Antwortinhalt. Ein 400-Validierungsfehler kann einen ZodError enthalten; Handler-Fehler verwenden die Felder error, message und code. Bewahre request_id oder x-request-id zur Diagnose ohne Zugangsdaten auf. Behebe 401/403-Zugriffsfehler vor einem erneuten Versuch und beachte Retry-After bei 429. Ist ein Schreibvorgang ungewiss oder liefert 5xx, lies zuerst das bestehende Ergebnis. Verwende einen Idempotenzschlüssel nur wieder, wo dies unterstützt wird; Wiederholungen unterscheiden sich je nach Operation und garantieren keine genau einmalige Zustellung.

Anleitung zur Fehlerbehebung

Beispiele

Diese Beispiele nutzen anhand der Schemas geprüfte fiktive Werte. Ersetze IDs durch autorisierte IDs, Medien durch bereite Assets und Daten durch bestätigte Veröffentlichungszeiten. Prüfe Kontoeignung vor Schreibvorgängen. Diese Seite sendet keine API-Anfragen.

Setze SOSOAPI_ACCESS_TOKEN auf deinem Server auf akzeptierte Zugangsdaten dieser Operation und halte es aus Browsercode heraus. Für KI-Agenten nutze sosoapi auth login zur Browseranmeldung und lass die CLI Zugangsdaten erneuern.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /research-api/projects/overview < request.json

Synthetisches Antwortbeispiel

{
  "project_id": "11111111-1111-4111-8111-111111111111",
  "project_revision": 1,
  "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111",
  "method_version": "literal-mentions/v1",
  "coverage": "supplied_set",
  "evidence_count": 0,
  "unique_items": 0,
  "brand_union_count": 0,
  "overlap_count": 0,
  "brands": [],
  "languages": [],
  "platforms": [],
  "sources": [],
  "history": {
    "eligible": false,
    "reason": "insufficient_comparable_history"
  }
}

MCP: sosoapi_research_projects_overview

Alle API-Operationen Authentifizierung und Berechtigungen

Datenschutzeinstellungen

Notwendige Funktionen

Optionale Nutzungsanalyse

Auch Sitzungsaufzeichnungen auf dieser öffentlichen Website erlauben

Übersicht eines ausgewählten Forschungskorpus lesen

Überblick

Authentifizierung und Berechtigungen

Anfragefelder

Antwort und Abschluss

Fehler und sichere Wiederholungen

Beispiele

request.json

cURL

JavaScript

CLI

Synthetisches Antwortbeispiel

Übersicht eines ausgewählten Forschungskorpus lesen

Überblick

Authentifizierung und Berechtigungen

Anfragefelder

Antwort und Abschluss

Fehler und sichere Wiederholungen

Beispiele

request.json

cURL

JavaScript

CLI

Synthetisches Antwortbeispiel

Verwandte Tools und Anleitungen