Klienci – eksport z wybranego segmentu

Z pomocą tych metod wyeksportujesz wybrane dane klientów znajdujących się w dowolnym segmencie.

POST – zlecenie eksportu danych

Ta metoda umożliwia zlecenie eksportu danych. W odpowiedzi otrzymujesz status zlecenia oraz exportId potrzebny do pobrania danych.

Endpoint

Endpoint, czyli adres serwera dla tego zapytania to: https://api.ecdp.app/exports/customers

Parametry zapytania

System attribute item

Custom attribute item

Consent item

Jak obsługujemy zduplikowane pola?

Jeśli w zapytaniu poprosisz jednocześnie o wszystkie cechy (używając ‘all: true’) i wskażesz kilka konkretnych cech z tej samej grupy, wyeksportujemy po prostu wszystkie cechy. System zignoruje nadmiarowe informacje, aby uniknąć duplikatów.

Przykładowe zapytania

Eksport danych wszystkich klientów z wybranego segmentu

Eksportujesz dane klientów z segmentu o ID 1 obejmujące wszystkie cechy systemowe, klienta oraz zgody.

Treść zapytania:

{
  "segmentId": 1,
  "data": {
    "customAttributes": [
      {"all": true}
    ],
    "systemAttributes": [
      {"all": true}
    ],
    "consents": [
      {"all": true}
    ]
  }
}

{
  "segmentId": 1,
  "data": {
    "customAttributes": [
      {"all": true}
    ],
    "systemAttributes": [
      {"all": true}
    ],
    "consents": [
      {"all": true}
    ]
  }
}

Eksport z segmentu klientów z wybranymi cechami

Eksportujesz dane klientów z segmentu o ID 158 obejmujące:

• custom attribute o nazwie zgoda konkurs
• system attribute o nazwie Email
• system attribute o ID 4
• zgodzie o ID 6
• zgodzie o nazwie consent

Treść zapytania:

{
  "segmentId": 158,
  "data": {
    "customAttributes": [
      {"name": "contest consent"}
    ],
    "systemAttributes": [
      {"name": "Email"},
      {"id": 4}
    ],
    "consents": [
      {"id": 6},
      {"name": "consent"}
    ]
  }
}

{
  "segmentId": 158,
  "data": {
    "customAttributes": [
      {"name": "contest consent"}
    ],
    "systemAttributes": [
      {"name": "Email"},
      {"id": 4}
    ],
    "consents": [
      {"id": 6},
      {"name": "consent"}
    ]
  }
}

Eksport z segmentu klientów ze wszystkimi cechami własnymi i jedną systemową

Eksportujesz dane klientów z segmentu o ID 12, obejmujące:

• wszystkie custom attributes
• jeden system attribute o nazwie ID

Treść zapytania:

{
  "segmentId": 12,
  "data": {
   "customAttributes": [
       {"all": true}
   ],
   "systemAttributes": [
       {"name": "ID"}
   ]
  }
}

{
  "segmentId": 12,
  "data": {
   "customAttributes": [
       {"all": true}
   ],
   "systemAttributes": [
       {"name": "ID"}
   ]
  }
}

Odpowiedzi

200: Success

Po przesłaniu zapytania otrzymasz odpowiedź zawierającą exportId oraz status zlecenia eksportu. Status Queued oznacza, że przyjęte zlecenie czeka w kolejce na realizację.

Przykładowa odpowiedź:

{
  "exportId": "12",
  "status": "Queued"
}

{
  "exportId": "12",
  "status": "Queued"
}

401: Unauthorized

W żądaniu brakowało klucza API lub prosisz o dostęp do informacji, do których nie masz uprawnień.

GET – odpytanie o wynik eksportu

Metoda GET umożliwia pobranie danych klientów. Otrzymasz link do pobrania pliku w formacie CSV lub pliku z surowymi danymi.

Endpoint

Gdy eksport danych się zakończy, możesz pobrać dwa rodzaje plików:

• Plik CSV

Endpoint: https://api.ecdp.app/exports/customers/{exportId}

Plik ten zawiera nagłówki kolumn i nadaje się do przeglądania danych w MS Excel czy Arkusze Google lub do importu w systemach, które wymagają standardowego formatu CSV.

• Plik z surowymi danymi

Endpoint: https://api.ecdp.app/exports/{exportId}

Plik ten jest specjalnie przygotowany do użycia w zewnętrznych narzędziach, np. w systemach reklamowych (Google Ads lub Meta Ads) do twprzenia niestandardowych list odbiorców.

Parametry zapytania

Odpowiedzi

200: Success

Po zakończeniu eksportu otrzymasz odpowiedź zawierającą link z plikiem do pobrania. Pliku jest aktywny przez 24 godziny od momentu jego wygenerowania. Po tym czasie plik jest usuwany z serwera, a kolejna próba jego pobrania zakończy się błędem.

Przykładowa odpowiedź:

{
  "exportId": 12,
  "status": "Finished",
  "file_url": "https://api.dev.ecdp/exports/12?apiKey=ls22fChPm5orIuT2bDt9"
}

{
  "exportId": 12,
  "status": "Finished",
  "file_url": "https://api.dev.ecdp/exports/12?apiKey=ls22fChPm5orIuT2bDt9"
}

401: Unauthorized

W żądaniu brakowało klucza API lub prosisz o dostęp do informacji, do których nie masz uprawnień.

Statusy eksportów

Odpowiedź może zawierać jeden z czterech statusów:

1. Queued – zlecenie zostało przyjęte i czeka w kolejce na realizację.
2. InProgress – eksport jest w trakcie realizacji.
3. Finished – eksport zakończył się powodzeniem. W tej samej odpowiedzi dostaniesz link do pliku z danymi.
4. Error – nie udało się wyeksportować danych ze wskazanego segmentu.

Dokumentacja referencyjna

Swagger – sekcja Exports

https://api.ecdp.app/swagger/index.html