Prompts

Die Fragen, die wir im eingestellten Tracking-Rhythmus des Kontos an KI-Modelle stellen, und die Datensätze der Ausführungen, die jeder Durchlauf erzeugt.

GET/dimensions/prompts

Listet die Prompts eines Projekts auf.

Parameter:
  • project_iderforderlich
  • modelnur Prompts mit mindestens einer Ausführung auf diesem Modell, unabhängig von Ergebnis oder Datum
  • collection_id
  • promptPrompt-ID
  • country_code
  • language_code
  • from
  • to
  • page
  • per_page≤100

Sowohl from als auch to filtern nach dem Erstellungsdatum des Prompts.

GET/dimensions/prompt_executions

Listet die Prompt-Ausführungen eines Projekts auf.

Parameter:
  • project_iderforderlich
  • model
  • collection_id
  • promptPrompt-ID
  • country_code
  • language_code
  • prompt_type
  • brand_kind
  • from
  • to
  • page
  • per_page
  • mention_filter
  • citation_filter
  • competitorsdie unter GET /answers beschriebene zweiachsige Matrix

GET/dimensions/query_fan_outs

Die Fan-out-Suchanfragen, die ein Modell bei der Beantwortung Ihrer Prompts im Tracking tatsächlich gestellt hat. Damit finden Sie die Formulierungen, nach denen die Modelle suchen, statt der Formulierungen, die Sie selbst geschrieben haben. view=query (Standard) liefert für jede Fan-out-Suchanfrage eine Zeile mit ihrer Anzahl und ihrem Anteil an allen Vorkommen; view=prompt liefert für jeden Prompt eine Zeile mit der Anzahl verschiedener Fan-out-Suchanfragen, die er ausgelöst hat. Fan-out-Suchanfragen werden vor allem von ChatGPT übermittelt; ein leeres Ergebnis bedeutet daher meist, dass die ausgewählten Modelle sie nicht bereitstellen.

Parameter:
  • project_iderforderlich
  • viewquery oder prompt
  • queryTeilzeichenfolge im Text der Fan-out-Suchanfrage
  • order
  • direction
  • model
  • collection_id
  • prompt
  • country_code
  • language_code
  • prompt_type
  • brand_kind
  • range
  • from
  • to
  • page
  • per_page
  • output

GET/suggested_prompts

Die Warteschlange „Vorgeschlagene Prompts“, dieselbe Liste wie im Tab „Vorgeschlagene Prompts“ der App: die Vorschläge aller Generatoren, die ältesten zuerst, standardmäßig nur ausstehende.

Parameter:
  • project_iderforderlich
  • sourcewebsite, magic, topic, reddit, paa, reputational, translate, gsc oder catalog
  • statuspending, accepted, rejected oder all
  • page
  • per_page≤100, Standard 50

GET/prompt_generations/:id

Fragen Sie einen Vorschlagsdurchlauf regelmäßig ab, bis sein Status completed (mit den gespeicherten Vorschlägen) oder failed (mit Fehlercode und Fehlermeldung) lautet. Die meisten Durchläufe sind innerhalb einer Minute abgeschlossen. Durchläufe werden 24 Stunden lang aufbewahrt, ihre Vorschläge bleiben in der Warteschlange.

Parameter:
  • project_iderforderlich
  • :iddie ID des Durchlaufs, in der URL

POST/prompts

Erstellt bis zu 100 Prompts pro Anfrage. Bereits vorhandene Prompts (gleicher Text sowie gleiches Land und gleiche Sprache) werden übersprungen.

Anfragetext (JSON):
  • project_iderforderlich
  • promptsArray, erforderlich, maximal 100
  • country_codeerforderlich
  • language_codeerforderlich

POST/prompts/import

Der CSV-Import der App als JSON. Jede Zeile enthält ihr eigenes Land, ihre eigene Sprache und ihre eigenen Tags. Fehlende Tags werden erstellt. Duplikate werden übersprungen, erhalten aber trotzdem die Tags ihrer Zeile. Würden die neuen Prompts das Tariflimit überschreiten, wird nichts importiert. Eine Zeile wird übersprungen und in row_errors zurückgegeben, wenn ihr Land oder ihre Sprache unbekannt ist, wenn ein Prompt durch sie mehr als 50 Tags hätte (Zeilen mit demselben Prompt werden zusammengezählt) oder wenn die Anfrage durch ihre Tags mehr als 500 neue Tags erstellen würde. Teammitglieder benötigen die Berechtigung „Erstellen“ für Tags, um ein Tag zu erstellen (ohne sie wird eine Zeile, die ein neues Tag braucht, übersprungen und in row_errors zurückgegeben), und die Berechtigung „Aktualisieren“ für Prompts, um einem bereits vorhandenen Prompt Tags zuzuweisen (ohne sie fügt die Zeile diesem Prompt keine Tags hinzu und wird in row_errors zurückgegeben, wenn sie eines hinzugefügt hätte). Erfordert einen API-Schlüssel mit Schreibzugriff und bei Teammitgliedern die Berechtigung „Erstellen“ für Prompts.

  • Anfragetext (JSON): project_id (erforderlich), rows (erforderliches Array, maximal 500) aus Zeilen mit prompt (erforderlich), country_code, language_code (Codes oder Namen, standardmäßig die des Projekts) und tags (Array von Namen).

POST/prompt_generations

Startet einen Vorschlagsdurchlauf mit einem der Generatoren, die auch die Assistenten unter „Prompts hinzufügen“ in der App nutzen. Die Anfrage wird mit 202 beantwortet, der Durchlauf läuft im Hintergrund. Seine Vorschläge landen in der Warteschlange „Vorgeschlagene Prompts“, und ins Tracking kommt nur, was Sie übernehmen. Erfordert einen API-Schlüssel mit Schreibzugriff.

  • Anfragetext (JSON): project_id (erforderlich), source (erforderlich: website, keyword, topic, reddit, paa, reputational, translate oder search_console), country_code und language_code (Standard: die Werte des Projekts). Je nach Wert von source: query (bei keyword optional, bei topic und reddit erforderlich), count (keyword und topic, 1-100, Standard 20), competitor_id (keyword), search_type (reddit: topic oder brand), keywords (paa, bis zu 5), source_country_code und source_language_code (translate), min_words und all_countries (search_console, ab Tarif Growth).

POST /suggested_prompts/accept + /reject

Übernimmt ausstehende Vorschläge als Prompts ins Tracking, jeweils mit eigenem Land und eigener Sprache und optional in einem Tag, oder lehnt sie ab, sodass sie aus der Liste der ausstehenden Vorschläge verschwinden. Würden die neuen Prompts das Prompt-Limit des Tarifs überschreiten, wird nichts übernommen (ERR_LIMIT_REACHED). Erfordert einen API-Schlüssel mit Schreibzugriff.

Anfragetext (JSON):
  • project_iderforderlich
  • idserforderliches Array, maximal 100

Beim Übernehmen kann zusätzlich ein Tag über tag_ids oder tag_names angegeben werden, dazu create_missing (boolescher Wert).

PATCH/prompts/:id

Legt die Suchintention (prompt_type) und/oder den Markenbezug (brand_kind) eines Prompts manuell fest, genau wie beim Bearbeiten dieser Angaben auf der Seite des Prompts. Der Prompt wird als manuell kategorisiert markiert (categorization_source wird zu manual), sodass die automatische Kategorisierung ihn nicht mehr ändert; auf der Seite des Prompts lässt sich die Kategorisierung wieder auf automatisch umstellen. Aus einem White-Label-Portal heraus ist der Endpunkt nicht verfügbar (ERR_INTEGRATION_UNAVAILABLE). Erfordert einen API-Schlüssel mit Schreibzugriff und bei Teammitgliedern die Berechtigung „Aktualisieren“ für Prompts. Auch als MCP-Tool update_prompt_categorization verfügbar.

Pfad:
  • :idPrompt-ID

Anfragetext (JSON): project_id (erforderlich), prompt_type (informational|navigational|commercial|transactional), brand_kind (brand|brand_other|non_brand); mindestens einer der beiden. Jedes andere Feld und jeder unbekannte Wert führen zu ERR_INVALID_PARAM.

DELETE/prompts/:id

Löscht einen Prompt. Der Vorgang ist endgültig: Der Prompt verschwindet sofort und gibt einen Platz im Prompt-Limit frei; anschließend löscht ein Hintergrundprozess den Verlauf des Prompts (Ausführungen, Erwähnungen, Zitierungen, Sentiment-Daten). Erfordert einen API-Schlüssel mit Schreibzugriff.

Parameter:
  • project_iderforderlich
  • :idin der URL

Für Prompts außerhalb des Projekts wird ERR_NOT_FOUND zurückgegeben.