Magic AI API (`/api/v1/magic-ai`)

Auf dieser Seite wird der programmatische Magic AI-Endpunkt beschrieben. Verwenden Sie ihn zusammen mit einem API-Schlüssel, um denselben Ablauf zur Erkennung von Wettbewerbern auszuführen, der auch im Dashboard verwendet wird.

Methode: BEITRAG
Pfad: /api/v1/magic-ai
Autor: X-API-Schlüssel oder Authorization: Bearer <key>
Inhaltstyp: Formular-Nutzdaten (application/x-www-form-urlencoded oder multipart/form-data)

Verwendung /api/v1/magic-ai für Integrationen mit API-Schlüsseln.
/api/magic-ai ist die von der Web-App verwendete Route für die Dashboard-Sitzung.

Mindestumfang des Anfragetextes

Geben Sie mindestens einen Suchbegriff ein:

Text (Freitext-Eingabeaufforderung) oder
Bild (hochgeladene Datei) oder
Bild-URL (URL des öffentlichen Bildes)

Empfohlene Paginierungsfelder für die deterministische Paginierung:

Seite (Beginnen Sie mit 0)
scrollen (leere Zeichenkette bei der ersten Anfrage; anschließend die scrollen (von der vorherigen Antwort zurückgegeben)

Optionale

Sie können dieselben Filter übergeben, die auch in der Magic-AI-Benutzeroberfläche verwendet werden:

Länder - durch Kommas getrennte Ländercodes oder Alle
von, zu - Zeitraum für das Startdatum
seit dem letzten Besuch, zu sehen - Zeitraum, in dem der Nutzer zuletzt online war
activefilter=aktiv - beschränkt die Ergebnisse auf Anzeigen, die in den letzten 4 Tagen zuletzt angesehen wurden
minadspend, maximale Werbeausgaben - Bandbreite der Werbeausgaben
Mindays, maxdays - Bereich der letzten Tage
adscorefilter - Voreinstellung für die Anzeigenbewertung

Wird kein Filter angegeben, gelten die Standardeinstellungen des Produkts.

Beispiel: Textsuche

curl -sS \
  -H "X-API-Key: $WH_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded; charset=UTF-8" \
  -X POST "{origin}/api/v1/magic-ai" \
  --data-urlencode "text=Find winning beauty products for US women 25-34" \
  --data-urlencode "countries=US" \
  --data-urlencode "page=0" \
  --data-urlencode "scroll="

Beispiel: Weiter

curl -sS \
  -H "X-API-Key: $WH_API_KEY" \
  -H "Content-Type: application/x-www-form-urlencoded; charset=UTF-8" \
  -X POST "{origin}/api/v1/magic-ai" \
  --data-urlencode "text=Find winning beauty products for US women 25-34" \
  --data-urlencode "countries=US" \
  --data-urlencode "page=1" \
  --data-urlencode "scroll=<scroll_token_from_previous_response>"

Antwortform

Typische Erfolgsmeldung:

{
  "data": [
    {
      "id": "...",
      "ad_creative_body": "...",
      "ad_snapshot_url": "...",
      "image_url": "...",
      "country": "US"
    }
  ],
  "scroll": "..."
}

Daten ist eine Reihe passender Anzeigen.
scrollen ist der Zeiger für die nächste Seite. Wenn keine Daten mehr vorhanden sind, kann er leer sein.

Fehler und

Dieser Endpunkt unterliegt denselben Regeln für die API-Schlüssel-Authentifizierung und die Nutzungsmessung wie der Rest der Standard-API-Oberfläche:

401 Ungültiger/fehlender API-Schlüssel
403 Das Konto umfasst keinen API-Zugang
429 Nutzungslimit oder monatliches Guthaben aufgebraucht

Siehe:

Magic AI API (/api/v1/magic-ai)

Endpunkt#

Mindestumfang des Anfragetextes#

Optionale Filter#

Beispiel: Textsuche#

Beispiel: Weiter zur Paginierung#

Antwortform#