Zielgruppen

Basis-URL: https://app.neuroflash.com/api/audience-service

Erstellen und verwalten Sie Zielgruppenprofil für Ihren Arbeitsbereich.

Eine neue Zielgruppe erstellen

POST/v1/workspaces/{workspaceId}/target-audiences

Erstellt eine neue Zielgruppe für den angegebenen Arbeitsbereich

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID

Anfrage-Body

countrystringNein

genderDistributionobjectJa

femalenumberJa

malenumberJa

nonBinarynumberJa

preferNotToSaynumberJa

interestsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeintegerJa

minAgeintegerJaWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestringJa

nativeLanguagestringNein

needsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

painPointsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestringJa

sharedbooleanJa

Antwort

_embeddedobject

imageobjectEin Bild, das einer Zielgruppe zugeordnet ist

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

permissionsobject

canDeleteboolean

canDuplicateboolean

canUpdateboolean

canViewboolean

countrystring

createdAtstring

createdByUserIdstring

genderDistributionobject

femalenumber

malenumber

nonBinarynumber

preferNotToSaynumber

idstring

interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeinteger

minAgeintegerWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestring

nativeLanguagestring

needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

ownerCustomerIdinteger

painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestring

sharedboolean

updatedAtstring

viewedAtstring

workspaceIdstring

Beispiel

Geschlechterverteilung muss in Summe 1,0 ergeben

Die vier Felder in genderDistribution (female, male, nonBinary, preferNotToSay) sind alle erforderlich und ihre Werte müssen in Summe exakt 1.0 ergeben. Die API gibt einen 400-Fehler zurück, wenn ein Feld fehlt oder die Summe nicht stimmt.

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "country": "string",
      "genderDistribution": {
        "female": 0.5,
        "male": 0.4,
        "nonBinary": 0.07,
        "preferNotToSay": 0.03
      },
      "interests": [],
      "maxAge": 0,
      "minAge": 0,
      "name": "string",
      "nativeLanguage": "string",
      "needs": [],
      "painPoints": [],
      "residence": "string",
      "shared": false
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "country": "string",
        "genderDistribution": {
        "female": 0.5,
        "male": 0.4,
        "nonBinary": 0.07,
        "preferNotToSay": 0.03
      },
        "interests": [],
        "maxAge": 0,
        "minAge": 0,
        "name": "string",
        "nativeLanguage": "string",
        "needs": [],
        "painPoints": [],
        "residence": "string",
        "shared": False
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "country": "string",
          "genderDistribution": {
        "female": 0.5,
        "male": 0.4,
        "nonBinary": 0.07,
        "preferNotToSay": 0.03
      },
          "interests": [],
          "maxAge": 0,
          "minAge": 0,
          "name": "string",
          "nativeLanguage": "string",
          "needs": [],
          "painPoints": [],
          "residence": "string",
          "shared": false
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"country": "string",
		"genderDistribution": map[string]any{
		"female": 0.5,
		"male": 0.4,
		"nonBinary": 0.07,
		"preferNotToSay": 0.03,
		},
		"interests": []any{},
		"maxAge": 0,
		"minAge": 0,
		"name": "string",
		"nativeLanguage": "string",
		"needs": []any{},
		"painPoints": []any{},
		"residence": "string",
		"shared": false,
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "image": {
      "createdAt": "2025-01-14T16:20:59Z",
      "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
      "fileName": "string",
      "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
      "targetAudienceId": "string",
      "updatedAt": "2025-01-14T16:20:59Z",
      "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
    },
    "permissions": {
      "canDelete": false,
      "canDuplicate": false,
      "canUpdate": false,
      "canView": false
    }
  },
  "country": "US",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "genderDistribution": {
    "female": 0.5,
    "male": 0.4,
    "nonBinary": 0.07,
    "preferNotToSay": 0.03
  },
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "interests": [
    "string"
  ],
  "maxAge": 65,
  "minAge": 18,
  "name": "Young urban professionals",
  "nativeLanguage": "de",
  "needs": [
    "string"
  ],
  "ownerCustomerId": 12345,
  "painPoints": [
    "string"
  ],
  "residence": "Berlin",
  "shared": true,
  "updatedAt": "2025-01-14T16:20:59Z",
  "viewedAt": "2025-01-14T16:20:59Z",
  "workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}

Create duplication

POST/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/duplication

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`targetAudienceId`	string	Ja	Zielgruppen-ID

Anfrage-Body

newNamestringNein

Antwort

duplicateobjectEine Zielgruppe ist eine Gruppe von Personen, die gemeinsame Eigenschaften haben, und Inhalte können auf sie ausgerichtet werden

_embeddedobject

imageobjectEin Bild, das einer Zielgruppe zugeordnet ist

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

permissionsobject

canDeleteboolean

canDuplicateboolean

canUpdateboolean

canViewboolean

countrystring

createdAtstring

createdByUserIdstring

genderDistributionobject

femalenumber

malenumber

nonBinarynumber

preferNotToSaynumber

idstring

interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeinteger

minAgeintegerWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestring

nativeLanguagestring

needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

ownerCustomerIdinteger

painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestring

sharedboolean

updatedAtstring

viewedAtstring

workspaceIdstring

originalobjectEine Zielgruppe ist eine Gruppe von Personen, die gemeinsame Eigenschaften haben, und Inhalte können auf sie ausgerichtet werden

_embeddedobject

imageobjectEin Bild, das einer Zielgruppe zugeordnet ist

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

permissionsobject

canDeleteboolean

canDuplicateboolean

canUpdateboolean

canViewboolean

countrystring

createdAtstring

createdByUserIdstring

genderDistributionobject

femalenumber

malenumber

nonBinarynumber

preferNotToSaynumber

idstring

interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeinteger

minAgeintegerWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestring

nativeLanguagestring

needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

ownerCustomerIdinteger

painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestring

sharedboolean

updatedAtstring

viewedAtstring

workspaceIdstring

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/duplication" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "newName": "string"
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/duplication",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "newName": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/duplication`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "newName": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"newName": "string",
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/duplication", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "duplicate": {
    "_embedded": {
      "image": {
        "createdAt": "2025-01-14T16:20:59Z",
        "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
        "fileName": "string",
        "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
        "targetAudienceId": "string",
        "updatedAt": "2025-01-14T16:20:59Z",
        "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
      },
      "permissions": {
        "canDelete": false,
        "canDuplicate": false,
        "canUpdate": false,
        "canView": false
      }
    },
    "country": "US",
    "createdAt": "2025-01-14T16:20:59Z",
    "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
    "genderDistribution": {
    "female": 0.5,
    "male": 0.4,
    "nonBinary": 0.07,
    "preferNotToSay": 0.03
  },
    "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
    "interests": [
      "string"
    ],
    "maxAge": 65,
    "minAge": 18,
    "name": "Young urban professionals",
    "nativeLanguage": "de",
    "needs": [
      "string"
    ],
    "ownerCustomerId": 12345,
    "painPoints": [
      "string"
    ],
    "residence": "Berlin",
    "shared": true,
    "updatedAt": "2025-01-14T16:20:59Z",
    "viewedAt": "2025-01-14T16:20:59Z",
    "workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
  },
  "original": {
    "_embedded": {
      "image": {
        "createdAt": "2025-01-14T16:20:59Z",
        "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
        "fileName": "string",
        "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
        "targetAudienceId": "string",
        "updatedAt": "2025-01-14T16:20:59Z",
        "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
      },
      "permissions": {
        "canDelete": false,
        "canDuplicate": false,
        "canUpdate": false,
        "canView": false
      }
    },
    "country": "US",
    "createdAt": "2025-01-14T16:20:59Z",
    "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
    "genderDistribution": {
    "female": 0.5,
    "male": 0.4,
    "nonBinary": 0.07,
    "preferNotToSay": 0.03
  },
    "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
    "interests": [
      "string"
    ],
    "maxAge": 65,
    "minAge": 18,
    "name": "Young urban professionals",
    "nativeLanguage": "de",
    "needs": [
      "string"
    ],
    "ownerCustomerId": 12345,
    "painPoints": [
      "string"
    ],
    "residence": "Berlin",
    "shared": true,
    "updatedAt": "2025-01-14T16:20:59Z",
    "viewedAt": "2025-01-14T16:20:59Z",
    "workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
  }
}

Zielgruppen auflisten

GET/v1/workspaces/{workspaceId}/target-audiences

Alle Zielgruppen auflisten, auf die der Benutzer Zugriff hat

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID

Abfrageparameter

Parameter	Typ	Standard	Beschreibung
`page`	integer	—	Seitennummer
`size`	integer	—	Seitengröße
`search`	string	—	Zielgruppe nach Name suchen
`country`	string	—	Zielgruppe nach Land filtern
`nativeLanguage`	string	—	Zielgruppe nach Muttersprache filtern

Antwort

dataarray<object>

_embeddedobject

imageobjectEin Bild, das einer Zielgruppe zugeordnet ist

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

permissionsobject

canDeleteboolean

canDuplicateboolean

canUpdateboolean

canViewboolean

countrystring

createdAtstring

createdByUserIdstring

genderDistributionobject

femalenumber

malenumber

nonBinarynumber

preferNotToSaynumber

idstring

interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeinteger

minAgeintegerWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestring

nativeLanguagestring

needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

ownerCustomerIdinteger

painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestring

sharedboolean

updatedAtstring

viewedAtstring

workspaceIdstring

pageobject

currentPageinteger

sizeinteger

totalElementsinteger

totalPagesinteger

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "data": [
    {
      "_embedded": {
        "image": {
          "createdAt": "...",
          "createdByUserId": "...",
          "fileName": "...",
          "id": "...",
          "targetAudienceId": "...",
          "updatedAt": "...",
          "url": "..."
        },
        "permissions": {
          "canDelete": "...",
          "canDuplicate": "...",
          "canUpdate": "...",
          "canView": "..."
        }
      },
      "country": "US",
      "createdAt": "2025-01-14T16:20:59Z",
      "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
      "genderDistribution": {
    "female": 0.5,
    "male": 0.4,
    "nonBinary": 0.07,
    "preferNotToSay": 0.03
  },
      "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
      "interests": [
        "string"
      ],
      "maxAge": 65,
      "minAge": 18,
      "name": "Young urban professionals",
      "nativeLanguage": "de",
      "needs": [
        "string"
      ],
      "ownerCustomerId": 12345,
      "painPoints": [
        "string"
      ],
      "residence": "Berlin",
      "shared": true,
      "updatedAt": "2025-01-14T16:20:59Z",
      "viewedAt": "2025-01-14T16:20:59Z",
      "workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
    }
  ],
  "page": {
    "currentPage": 2,
    "size": 10,
    "totalElements": 35,
    "totalPages": 4
  }
}

Eine Zielgruppe nach ID abrufen

GET/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}

Ruft eine Zielgruppe anhand ihrer ID ab

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`targetAudienceId`	string	Ja	Zielgruppen-ID

Antwort

_embeddedobject

imageobjectEin Bild, das einer Zielgruppe zugeordnet ist

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

permissionsobject

canDeleteboolean

canDuplicateboolean

canUpdateboolean

canViewboolean

countrystring

createdAtstring

createdByUserIdstring

genderDistributionobject

femalenumber

malenumber

nonBinarynumber

preferNotToSaynumber

idstring

interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeinteger

minAgeintegerWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestring

nativeLanguagestring

needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

ownerCustomerIdinteger

painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestring

sharedboolean

updatedAtstring

viewedAtstring

workspaceIdstring

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "image": {
      "createdAt": "2025-01-14T16:20:59Z",
      "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
      "fileName": "string",
      "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
      "targetAudienceId": "string",
      "updatedAt": "2025-01-14T16:20:59Z",
      "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
    },
    "permissions": {
      "canDelete": false,
      "canDuplicate": false,
      "canUpdate": false,
      "canView": false
    }
  },
  "country": "US",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "genderDistribution": {
    "female": 0.5,
    "male": 0.4,
    "nonBinary": 0.07,
    "preferNotToSay": 0.03
  },
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "interests": [
    "string"
  ],
  "maxAge": 65,
  "minAge": 18,
  "name": "Young urban professionals",
  "nativeLanguage": "de",
  "needs": [
    "string"
  ],
  "ownerCustomerId": 12345,
  "painPoints": [
    "string"
  ],
  "residence": "Berlin",
  "shared": true,
  "updatedAt": "2025-01-14T16:20:59Z",
  "viewedAt": "2025-01-14T16:20:59Z",
  "workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}

Ein Zielgruppenbild abrufen

GET/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image

Gibt eine signierte URL für das Zielgruppenbild zurück

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`targetAudienceId`	string	Ja	Zielgruppen-ID

Antwort

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/image`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/image", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "fileName": "string",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "targetAudienceId": "string",
  "updatedAt": "2025-01-14T16:20:59Z",
  "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
}

Eine Zielgruppe aktualisieren

PUT/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}

Aktualisiert eine vorhandene Zielgruppe

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`targetAudienceId`	string	Ja	Zielgruppen-ID

Anfrage-Body

countrystringNein

genderDistributionobjectJa

femalenumberJa

malenumberJa

nonBinarynumberJa

preferNotToSaynumberJa

interestsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeintegerJa

minAgeintegerJaWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestringJa

nativeLanguagestringNein

needsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

painPointsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestringJa

sharedbooleanJa

Antwort

_embeddedobject

imageobjectEin Bild, das einer Zielgruppe zugeordnet ist

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

permissionsobject

canDeleteboolean

canDuplicateboolean

canUpdateboolean

canViewboolean

countrystring

createdAtstring

createdByUserIdstring

genderDistributionobject

femalenumber

malenumber

nonBinarynumber

preferNotToSaynumber

idstring

interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

maxAgeinteger

minAgeintegerWir speichern die Altersgruppe als separate Min-/Max-Felder in der Datenbank

namestring

nativeLanguagestring

needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

ownerCustomerIdinteger

painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind

residencestring

sharedboolean

updatedAtstring

viewedAtstring

workspaceIdstring

Beispiel

Vollständiges Profil bei jeder Aktualisierung erforderlich

Der Update-Endpunkt verwendet PUT-Semantik — Sie müssen bei jedem Aufruf das vollständige demografische Profil übergeben, auch wenn Sie nur ein Feld ändern möchten. Rufen Sie die Zielgruppe zuerst mit GET /target-audiences/{id} ab und senden Sie dann alle bestehenden Werte mit Ihrer Änderung zurück.

cURL
Python
Node.js
Go

curl -X PUT "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "country": "string",
      "genderDistribution": {},
      "interests": [],
      "maxAge": 0,
      "minAge": 0,
      "name": "string",
      "nativeLanguage": "string",
      "needs": [],
      "painPoints": [],
      "residence": "string",
      "shared": false
  }'

import requests

response = requests.put(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "country": "string",
        "genderDistribution": {},
        "interests": [],
        "maxAge": 0,
        "minAge": 0,
        "name": "string",
        "nativeLanguage": "string",
        "needs": [],
        "painPoints": [],
        "residence": "string",
        "shared": False
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}`,
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "country": "string",
          "genderDistribution": {},
          "interests": [],
          "maxAge": 0,
          "minAge": 0,
          "name": "string",
          "nativeLanguage": "string",
          "needs": [],
          "painPoints": [],
          "residence": "string",
          "shared": false
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"country": "string",
		"genderDistribution": map[string]any{},
		"interests": []any{},
		"maxAge": 0,
		"minAge": 0,
		"name": "string",
		"nativeLanguage": "string",
		"needs": []any{},
		"painPoints": []any{},
		"residence": "string",
		"shared": false,
	})

req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "image": {
      "createdAt": "2025-01-14T16:20:59Z",
      "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
      "fileName": "string",
      "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
      "targetAudienceId": "string",
      "updatedAt": "2025-01-14T16:20:59Z",
      "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
    },
    "permissions": {
      "canDelete": false,
      "canDuplicate": false,
      "canUpdate": false,
      "canView": false
    }
  },
  "country": "US",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "genderDistribution": {
    "female": 0.5,
    "male": 0.4,
    "nonBinary": 0.07,
    "preferNotToSay": 0.03
  },
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "interests": [
    "string"
  ],
  "maxAge": 65,
  "minAge": 18,
  "name": "Young urban professionals",
  "nativeLanguage": "de",
  "needs": [
    "string"
  ],
  "ownerCustomerId": 12345,
  "painPoints": [
    "string"
  ],
  "residence": "Berlin",
  "shared": true,
  "updatedAt": "2025-01-14T16:20:59Z",
  "viewedAt": "2025-01-14T16:20:59Z",
  "workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}

Das Symbol einer Zielgruppe aktualisieren

PUT/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`targetAudienceId`	string	Ja	Zielgruppen-ID

Anfrage-Body

base64stringJa

contentTypestringJa

fileNamestringJa

Antwort

createdAtstring

createdByUserIdstring

fileNamestringDer Dateiname wird verwendet, um einen Speicherschlüssel zu generieren, der bei Duplikaten ebenfalls mit dem Dateinamen endet

idstring

targetAudienceIdstring

updatedAtstring

urlstring

Beispiel

cURL
Python
Node.js
Go

curl -X PUT "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "base64": "string",
      "contentType": "string",
      "fileName": "string"
  }'

import requests

response = requests.put(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "base64": "string",
        "contentType": "string",
        "fileName": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/image`,
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "base64": "string",
          "contentType": "string",
          "fileName": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"base64": "string",
		"contentType": "string",
		"fileName": "string",
	})

req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/image", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "fileName": "string",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "targetAudienceId": "string",
  "updatedAt": "2025-01-14T16:20:59Z",
  "url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
}

Eine Verwendung von Zielgruppe erstellen

PUT/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/usage

Erstellt eine dokumentierte Verwendung einer Zielgruppe

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereich-ID (uuid4)
`targetAudienceId`	string	Ja	Zielgruppen-ID

Beispiel

cURL
Python
Node.js
Go

curl -X PUT "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/usage" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import requests

response = requests.put(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/usage",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/usage`,
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{})

req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/usage", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Eine Zielgruppe löschen

DELETE/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}

Löscht eine vorhandene Zielgruppe

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`targetAudienceId`	string	Ja	Zielgruppen-ID

Beispiel

cURL
Python
Node.js
Go

curl -X DELETE "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

requests.delete(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}",
    headers={"Authorization": f"Bearer {token}"},
)

await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${token}` },
  }
);

req, _ := http.NewRequest("DELETE", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Eigentümerschaft

Nur der Benutzer, der eine Zielgruppe erstellt hat, kann diese aktualisieren oder löschen. Der Versuch, eine Ressource eines anderen Benutzers zu ändern, gibt 403 Forbidden zurück.

Ein Zielgruppenbild löschen

DELETE/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image

Löscht ein vorhandenes Bild für eine Zielgruppe

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`targetAudienceId`	string	Ja	Zielgruppen-ID

Beispiel

cURL
Python
Node.js
Go

curl -X DELETE "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

requests.delete(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image",
    headers={"Authorization": f"Bearer {token}"},
)

await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/image`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${token}` },
  }
);

req, _ := http.NewRequest("DELETE", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/image", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Zielgruppengrenzen abrufen

GET/v1/workspaces/{workspaceId}/limits/target-audiences

Ruft Zielgruppengrenzen ab

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID

Antwort

createobject

isAvailableboolean

isUnlimitedboolean

limitinteger

usageinteger

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/limits/target-audiences" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/limits/target-audiences",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/audience-service/v1/workspaces/${workspaceId}/limits/target-audiences`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/audience-service/v1/workspaces/"+workspaceID+"/limits/target-audiences", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "create": {
    "isAvailable": false,
    "isUnlimited": false,
    "limit": 0,
    "usage": 0
  }
}

Eine neue Zielgruppe erstellen​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Create duplication​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Zielgruppen auflisten​

Pfadparameter​

Abfrageparameter​

Antwort​

Beispiel​

Eine Zielgruppe nach ID abrufen​

Pfadparameter​

Antwort​

Beispiel​

Ein Zielgruppenbild abrufen​

Pfadparameter​

Antwort​

Beispiel​

Eine Zielgruppe aktualisieren​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Das Symbol einer Zielgruppe aktualisieren​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Eine Verwendung von Zielgruppe erstellen​

Pfadparameter​

Beispiel​

Eine Zielgruppe löschen​

Pfadparameter​

Beispiel​

Ein Zielgruppenbild löschen​

Pfadparameter​

Beispiel​

Zielgruppengrenzen abrufen​

Pfadparameter​

Antwort​

Beispiel​

Eine neue Zielgruppe erstellen

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Create duplication

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Zielgruppen auflisten

Pfadparameter

Abfrageparameter

Antwort

Beispiel

Eine Zielgruppe nach ID abrufen

Pfadparameter

Antwort

Beispiel

Ein Zielgruppenbild abrufen

Pfadparameter

Antwort

Beispiel

Eine Zielgruppe aktualisieren

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Das Symbol einer Zielgruppe aktualisieren

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Eine Verwendung von Zielgruppe erstellen

Pfadparameter

Beispiel

Eine Zielgruppe löschen

Pfadparameter

Beispiel

Ein Zielgruppenbild löschen

Pfadparameter

Beispiel

Zielgruppengrenzen abrufen

Pfadparameter

Antwort

Beispiel