Eksport klientów z wybranego segmentu

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

1. POST – zlecenie eksportu danych. W odpowiedzi otrzymujesz status zlecenia oraz exportId potrzebny do pobrania danych.
2. GET – pobieranie danych. Otrzymujesz link do pobrania pliku w formacie CSV lub pliku z surowymi danymi.

POST – zlecenie eksportu danych

Żeby wysłać zapytanie z użyciem tej metody, musi ona zawierać:

Endpoint

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

Parametry zapytania

Nagłówek

Treść

Parametry systemAttributes, customAttributes oraz consents posiadają dodatkowe parametry, dzięki którym uzyskasz szczegółowe dane o klientach znajdujących się w wybranym segmencie.

System attributes (cechy systemowe)

Custom attributes (cechy klienta)

Consents (zgody)

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łady zapytań

Wymagany format zapytania: JSON

Przykład 1

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}
]
}
}

Przykład 2

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": "zgoda konkurs"}
   ],
    "systemAttributes": [
       {"name": "Email"},
       {"id": 4 }
   ],
    "consents": [
        {"id": 6 },
        {"name": "consent"}
   ]
  }
}

Przykład 3

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"}
   ]
  }
}

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"
}

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

Żeby dowiedzieć się o status eksportu, zapytanie musi zawierać:

Endpoint

Gdy eksport danych się zakończy, możesz pobrać plik na dwa sposoby. Wybierz endpoint, który lepiej pasuje do Twoich potrzeb:

• Standardowy plik CSV do analizy

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

Użyj tego adresu, jeśli chcesz pobrać plik w formacie CSV. 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 dla platform reklamowych

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

Ten adres pozwala pobrać plik z surowymi danymi. Plik ten jest specjalnie przygotowany do importu w zewnętrznych narzędziach, np. do tworzenia niestandardowych list odbiorców (Custom Audiences) w systemach reklamowych Google Ads czy Meta Ads (Facebook).

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"
}

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.