Endpointy Power BI — lista dostępnych źródeł danych

System voxDeveloper CRM udostępnia szereg endpointów Power BI, które umożliwiają pobieranie danych z CRM w formacie JSON. Dzięki nim można tworzyć zaawansowane raporty i wizualizacje w programie Power BI, wspierające podejmowanie decyzji biznesowych.

Poniżej znajduje się pełna lista dostępnych endpointów wraz z opisem, dostępnymi filtrami oraz przykładami użycia.

Słowniczek pojęć

Ogólne zasady działania

• Wszystkie endpointy dostępne są pod ścieżką: /webservice/power-bi/source/{nazwa-endpointu}
• Autoryzacja odbywa się przez nagłówek Api-key z unikatowym kluczem API.
• Dane zwracane są w formacie JSON.
• Filtry nie są wymagane — bez filtrów endpoint pobiera dane dla wszystkich inwestycji dostępnych dla danego klucza API.
• Filtry przekazywane są jako elementy ścieżki URL, np.: /investment/Nazwa Inwestycji/date-from/2024-01-01

Zestawienie wszystkich endpointów

Leady i klienci

1. Raport leadów — porównanie (lead-comparision)

Zestawienie liczby leadów w podziale na miesiące i inwestycje. Domyślnie pokazuje dane z ostatnich 24 miesięcy.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• date-from/DATA_OD — początek zakresu dat
• date-to/DATA_DO — koniec zakresu dat

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/lead-comparision/investment/Osiedle Zielony Staw/date-from/2024-01-01/date-to/2024-12-31

2. Lista leadów (leads-list)

Szczegółowe informacje o leadach. Domyślnie pobiera dane z ostatnich 100 dni. Zawiera kolumny: klasyfikacja leada oraz status klienta.

Dostępne filtry:

• date-from/DATA_OD — data od
• date-to/DATA_DO — data do
• contact-status/STATUSY_PO_PRZECINKU — filtr statusu klienta

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/leads-list/date-from/2024-01-01/date-to/2024-12-31

3. Lista klientów (clients-list)

Szczegółowe informacje o klientach: dane osobowe, status, klasyfikacja, sposób finansowania, źródło pochodzenia, doradca, preferencje, zgody marketingowe, powiązane leady oraz dane UTM. Domyślnie wyświetla klientów z ostatnich 3 miesięcy.

Dostępne filtry:

• date_from/DATA_OD — data utworzenia klienta od (YYYY-MM-DD)
• date_to/DATA_DO — data utworzenia klienta do (YYYY-MM-DD)

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/clients-list/date_from/2024-01-01/date_to/2024-03-31

4. Raport po klientach (clients-report)

Szczegółowe informacje o klientach wraz z historią ich aktywności i preferencjami inwestycyjnymi.

Dostępne filtry:

• contact_created_date_from — data utworzenia klienta od (YYYY-MM-DD)
• contact_created_date_to — data utworzenia klienta do (YYYY-MM-DD)
• user_id — ID handlowca
• contact_status — status klienta w procesie sprzedażowym

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/clients_report?contact_created_date_from=2024-09-01&contact_created_date_to=2024-09-30&user_id=170

5. Raport po leadach (leads-report)

Informacje o leadach wraz z historią ich przetwarzania i aktywności sprzedażowej.

Dostępne filtry:

• lead_created_date_from — data utworzenia leada od (YYYY-MM-DD)
• lead_created_date_to — data utworzenia leada do (YYYY-MM-DD)
• user_id — ID handlowca

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/leads_report?lead_created_date_from=2024-09-01&lead_created_date_to=2024-09-30

6. Leady powiązane z umowami (lead-list-agreements)

Lista leadów powiązanych z umowami. Łączy dane leadów z informacjami o zawartych umowach.

7. Konwersje Google Ads (gclid-conversions)

Lista leadów z danymi konwersji Google Ads (GCLID). Służy do integracji offline konwersji z Google Ads. Zwraca tylko leady skonwertowane (powiązane z klientem) z uzupełnionym polem GCLID i klasyfikacją „Ciepły Lead”.

Dostępne filtry:

• data konwersji od/do
• nazwa inwestycji

Umowy i rezerwacje

8. Rejestr umów (agreements-registry)

Szczegółowe informacje o umowach, w tym dane klientów, powierzchnie lokali, ceny oraz daty podpisania. Zawiera również dane dotyczące lokali użytkowych.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/agreements-registry/investment/Osiedle Zielony Staw

9. Eksport listy umów (transaction-list)

Lista wszystkich umów dostępnych w systemie. Zawiera dodatkowe kolumny: „Budynek” oraz „Cena całkowita netto”.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• all-agreements/1 — pobieranie wszystkich umów

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/transaction-list/all-agreements/1/investment/Osiedle Zielony Staw

10. Lista umów (agreements-list)

Szczegółowe informacje dotyczące umów. Domyślnie pomija umowy anulowane.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• status/STATUSY_PO_PRZECINKU — status umowy: inprogress (W toku), signed (Podpisane), canceled (Anulowane)

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/agreements-list/status/inprogress,signed,canceled

11. Lista umów — rozszerzona (agreements)

Lista umów z rozszerzoną strukturą danych — zawiera m.in. identyfikatory transakcji (transaction_id) oraz identyfikatory klientów CRM (client_crm_id).

12. Lokale z rezerwacjami (reservations-list)

Lista lokali z rezerwacjami. Domyślnie filtruje tylko aktywne rezerwacje.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• all-agreements/1 — wszystkie umowy
• status/STATUSY_PO_PRZECINKU — status rezerwacji: Aktywne, Anulowane, Wygasłe (domyślnie: Aktywne)

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/reservations-list/status/Aktywne,Anulowane,Wygasle

13. Raport rezerwacji i umów (agreements-and-reservations)

Dane z raportu rezerwacji i umów. Łączy informacje o rezerwacjach i umowach w jednym endpointcie.

14. Anulowane umowy / Zwroty (returns)

Lista anulowanych umów sprzedaży. Zawiera dane o lokalu, datach umowy i anulowania oraz wartości umowy (netto/brutto).

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/returns/investment/Osiedle Zielony Staw

Płatności i finanse

15. Lista transz (schedule-payment-list)

Harmonogramy płatności dotyczące inwestycji. Domyślnie pokazuje dane z ostatnich 12 miesięcy.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• agreement-type/TYPY_UMOW_PO_PRZECINKU — typ umowy (Akt notarialny, Umowa deweloperska, Umowa rezerwacyjna)
• date-from/DATA_OD — początek zakresu dat terminów transz
• date-to/DATA_DO — koniec zakresu dat terminów transz
• only-not-paid/1 — tylko transze nieopłacone
• hide-lower/1 — ukrywanie transz z niższych umów
• remote-sync/1 — wyłącza pole „Client / Company full data” (optymalizacja wydajności)

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/schedule-payment-list/investment/Osiedle Zielony Staw/only-not-paid/1

16. Lista wpłat (payments)

Lista wpłat rozliczonych na rachunki powiernicze. Umożliwia integrację z systemami ERP.

Dostępne filtry:

• date_from — data początkowa wpłaty (YYYY-MM-DD)
• date_to — data końcowa wpłaty (YYYY-MM-DD)

17. Lista faktur (invoices)

Lista faktur wystawionych w systemie voxCRM. Umożliwia integrację z systemami ERP.

Dostępne filtry:

• date_from — data początkowa wystawienia faktury (YYYY-MM-DD)
• date_to — data końcowa wystawienia faktury (YYYY-MM-DD)

18. Prognoza sprzedaży (sales-forecast)

Szczegółowe informacje dotyczące umów i lokali z nimi powiązanych.

Dostępne filtry:

• date_from/DATA_OD — początek zakresu dat
• date_to/DATA_DO — koniec zakresu dat
• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/sales-forecast/date_from/2024-01-01/date_to/2025-01-01

Lokale i nieruchomości

19. Lista lokali (realestate-list)

Endpoint zwraca słownik wszystkich lokali w systemie — mapowanie „UUID lokalu → nazwa lokalu", pogrupowane według inwestycji. Jego zadaniem jest identyfikacja lokali, a nie raportowanie.

Dostępne filtry:

• investment — inwestycja

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/realestate-list/investment/Osiedle Zielony Staw

20. Lokale dostępne w sprzedaży (available-for-sale)

Lista lokali dostępnych w sprzedaży. Brane są pod uwagę tylko lokale o statusie „dostępne” oraz „rezerwacja ustna”.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/available-for-sale/investment/Osiedle Zielony Staw

21. Raport sprzedane i niesprzedane (sold-and-not-sold)

Szczegółowe informacje z raportu sprzedanych i niesprzedanych nieruchomości.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• agreement-type/TYPY_UMOW_PO_PRZECINKU — typ umowy (Akt notarialny, Umowa deweloperska, Umowa przedwstępna, Umowa rezerwacyjna)
• investment-stage/NAZWY_ETAPOW — etap (działa przy wyborze jednej inwestycji)
• investment-buildings/NAZWY_BUDYNKOW — budynek (działa przy wyborze jednej inwestycji)
• agreement-status/STATUSY_PO_PRZECINKU — status umowy (Podpisana, W toku)
• date-from/DATA_OD — termin podpisania umowy od
• date-to/DATA_DO — termin podpisania umowy do

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/sold-and-not-sold/date-from/2024-01-01/date-to/2024-12-31

22. Sprzedane przyległości (sold-associated-units)

Lista sprzedanych przyległości (komórki, boksy, miejsca parkingowe) powiązanych z umowami w toku i podpisanymi. Zawiera ceny zarządcze (brutto/netto, za m2) obliczane automatycznie.

23. Status sprzedaży inwestycji (investment-status)

Aktualny status sprzedaży dla inwestycji. Dane zagregowane o stanie sprzedaży lokali. Lokale komercyjne są wyłączone.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• status/NAZWA_STATUSU — filtrowanie po kategorii (sprzedane/zarezerwowane/pozostałe)

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/investment-status/investment/Osiedle Zielony Staw

Aktywności i kontakt

24. Raport spotkań (meeting)

Informacje o spotkaniach z klientami. Domyślnie pokazuje dane z bieżącego roku.

Dostępne filtry:

• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• date-from/DATA_OD — data spotkania od
• date-to/DATA_DO — data spotkania do

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/meeting/date-from/2024-01-01/date-to/2024-12-31/investment/Osiedle Zielony Staw

25. Lista aktywności klientów (activities-list)

Lista aktywności związanych z klientami (zadania, spotkania, telefony itp.).

Dostępne filtry:

• activity_date_from/DATA_OD — data początkowa (YYYY-MM-DD)
• activity_date_to/DATA_DO — data końcowa (YYYY-MM-DD)
• investment/NAZWY_INWESTYCJI_PO_PRZECINKU — wybór inwestycji
• activity_status/NAZWA_STATUSU — status aktywności

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/activities-list/activity_date_from/2024-09-01/activity_date_to/2024-09-30

26. Historia transakcji klientów (contact-transactions)

Informacje o wszystkich zdarzeniach związanych z danym klientem.

Dostępne filtry:

• date_from/DATA_OD — data początkowa (YYYY-MM-DD)
• date_to/DATA_DO — data końcowa (YYYY-MM-DD)
• investment_name/NAZWA_INWESTYCJI — nazwa inwestycji
• contact_id/ID_KLIENTA — ID klienta

Przykład:
https://domena.voxdeveloper.com/webservice/power-bi/source/contact-transactions/date_from/2024-01-01/date_to/2024-06-30

27. Połączenia przychodzące (incoming-call)

Dane o połączeniach przychodzących. Zawiera informacje o doradcach z tych samych oddziałów. Powiązany z integracją telefoniczną (Cludo). Endpoint nie przesyła danych usuniętych użytkowników.

28. Lista połączeń z aplikacji mobilnej (mobile-call-list)

Lista połączeń telefonicznych z aplikacji mobilnej. Każde połączenie zawiera: datę, numer telefonu, status (Wychodzące / Przychodzące / Nieodebrane), informację czy jest powiązane z klientem oraz czy klient posiada umowę.

Dostępne filtry:

• data połączenia od/do
• połączenia bez klientów z umową (Tak/Nie)

29. Lista użytkowników wg oddziałów (branch-users)

Lista użytkowników (doradców) z podziałem na oddziały. Informuje kto jest przypisany do danego oddziału. Nie przesyła danych usuniętych użytkowników.

Dokumenty i zmiany

30. Skany aneksów i cesji (annexes-and-cessions-scans)

Dane o skanach aneksów i cesji. Pozwala na monitorowanie statusu dokumentów związanych z aneksami i cesjami umów deweloperskich.

31. Lista zmian lokatorskich (realestate-changes-list)

Lista zmian lokatorskich dotyczących nieruchomości. Wykorzystywany m.in. przy kopiowaniu umów z innych paneli.

32. Dokumenty zmian lokatorskich (realestate-changes-documents)

Dokumenty powiązane ze zmianami lokatorskimi. Uzupełnia dane z endpointu realestate-changes-list o dokumentację.

Techniczne i hurtownia danych

33. Lista dostępnych endpointów (endpoints)

Endpoint meta-informacyjny zwracający listę wszystkich dostępnych endpointów Power BI dla danego klucza API. Umożliwia programowe sprawdzenie jakie źródła danych są dostępne.

34. Rejestr umów — zanonimizowany (transaction-list-anonymized)

Okrojona wersja rejestru umów bez danych osobowych (imię, nazwisko, adres, PESEL, e-mail, telefon, dane o lokalizacji). Stworzony na potrzeby hurtowni danych.

35. Zestawienie umów wg źródła pozyskania (warehouse-contracts-by-source)

Zanonimizowane zestawienie leadów, klientów, aktywności i umów w podziale na inwestycję i źródło pozyskania. Stworzony na potrzeby hurtowni danych. Anonimizacja deweloperów i inwestycji generowana dynamicznie.

Dostępne filtry:

• date-from/YYYY-MM-DD — data utworzenia od
• date-to/YYYY-MM-DD — data utworzenia do

Integracja systemu CRM z programem Power BI pozwala na pełne wykorzystanie potencjału danych. Dzięki możliwości stosowania filtrów mogą Państwo w prosty sposób dostosować zakres danych do swoich potrzeb, a następnie tworzyć raporty i wizualizacje wspierające codzienną pracę.

W przypadku pytań lub problemów z konfiguracją, prosimy o kontakt z działem wsparcia technicznego.