openapi: 3.0.0
info:
version: 1.0.0
title: CDP (Customer Data Platform) API
description: "This document serves as the \U0001F4D8 comprehensive API guide for \U0001F50C integrating\
\ your product(s) with the Lucidya **Customer Data Platform (CDP)** via **RESTful** endpoints.\n\n\
\U0001F50D Explore how to seamlessly connect your offerings with our platform to leverage customer\
\ data insights and profiles.\n\nMethod | Endpoint | Description\n-------|----------|---------\n `GET`\
\ | **[Get Filters](https://docs.lucidya.com/docs/cdp-api/branches/main/7k92xwdm05e0i-get-filters)**\
\ | Reterive a list of all available filters on your account.\n `GET` | **[Get Profile List](https://docs.lucidya.com/docs/cdp-api/branches/main/3mjmoshm1vmcu-get-a-list-of-all-profiles)**\
\ | Reterive a list of all available customer profiles.\n `GET` | **[Get Profile by Id](https://docs.lucidya.com/docs/cdp-api/branches/main/b0aykazg3489q-get-custom-profile-data-by-id)**\
\ | Reterive a specific customer profile data by `profile_id`.\n `POST`| **[Create Profile](https://docs.lucidya.com/docs/cdp-api/c2d0471ce7599-create-profile)**\
\ | Create a new CDP profile by adding the profile information.\n `PUT` | **[Update Profile](https://docs.lucidya.com/docs/cdp-api/10c0d3000016a-update-profile)**\
\ | Update the information for a specific profile.\n `GET` | **[Get Survey data by Profile Id](https://docs.lucidya.com/docs/cdp-api/branches/main/zb4668e65pnoz-retrieve-survey-data-for-a-specific-profile-using-its-id)**\
\ | Reterive a data of all survey(ies) for specific customer by `profile_id`.\n `POST`| **[Create\
\ Interaction Profile](https://docs.lucidya.com/docs/cdp-api/branches/main/2kqwzyyvxixnr-create-interaction-profile)**\
\ | Create an interaction profile to get the `job_id`.\n `GET` | **[Get Interaction Profile](https://docs.lucidya.com/docs/cdp-api/branches/main/m7c5hv4h94339-get-interaction-profile-by-id)**\
\ | Reterive an interaction profile by `job_id` and `profile_id`.\n `GET` | **[Get Segments List](https://docs.lucidya.com/docs/cdp-api/6c947c3eaec37-paginated-segments-list)**\
\ | Retrieve a paginated list of segments associated with your account.\n `PUT` | **[Append Profile(s)\
\ to Segment](https://docs.lucidya.com/docs/cdp-api/ec7081a06df11-append-profile-s-into-segment)**\
\ | Add selected profiles to the segment.\n `DELETE` | **[Delete Profile(s) from Segment](https://docs.lucidya.com/docs/cdp-api/a0ac3ea7ae575-delete-profile-s-from-segment)**\
\ | Remove selected profiles from the segment.\n\n[\U0001F393 Learn more about Lucidya CDP](https://lucidya.com/product/audience/)."
termsOfService: https://lucidya.com/service-agreement/
contact:
name: Lucidya
url: https://lucidya.com/
email: customer.support@lucidya.com
license:
url: ''
name: ''
servers:
- url: https://api.lucidya.com
description: Production Server
paths:
/profiles/filters:
get:
tags:
- Filters
summary: Get filters
description: 'Utilize the `Get Filters` endpoint to **retrieve a list of filters** available in
your CDP account.
You can get a list of all supported filters:
- **🔖 Segment**: You will get an array containing all available options for segment filter.
- **🔍 Data Source**: You will get an array containing all available options for data source filter.
- **📍 Location**: You will get an array containing all available options for location filter.
- **👦 Gender**: You will get an array containing all available options for gender filter.
- **✨ Themes**: You will get an array containing all available options for themes filter.
- **🖼️ Sub Themes**: You will get an array containing all available options for sub themes filter.
- **🗣️ Dialects**: You will get an array containing all available options for dialects filter.
- **🎭 Sub Dialects**: You will get an array containing all available options for sub dialects
filter.
'
operationId: getFilters
parameters:
- name: luc-authorization
in: header
description: This is used to add the `API key` generated from your Lucidya account to authenticate.
required: true
schema:
type: string
responses:
'200':
description: "```json\n{\n \"data\": [\n {\n \"id\": 53,\n \"\
name\": \"segment\",\n \"selection_attribute\": \"multi-select\",\n \
\ \"content_source\": \"engine_dynamic_api\",\n \"placeholder\": null,\n \
\ \"locale_source\": null,\n \"default_value\": null,\n \"priority\"\
: \"1\",\n \"options\": [\n {\n \"label\": \"\
T\",\n \"value\": 77\n },\n {\n \
\ \"label\": \"magdy\",\n \"value\": 76\n },\n\
\ {\n \"label\": \"hi\",\n \"value\"\
: 75\n },\n {\n \"label\": \"TestwShoroog\"\
,\n \"value\": 74\n },\n {\n \
\ \"label\": \"ShoroogSegment\",\n \"value\": 73\n \
\ },\n {\n \"label\": \"test1234567948822323\",\n \
\ \"value\": 72\n },\n {\n \
\ \"label\": \"Al\",\n \"value\": 70\n },\n \
\ {\n \"label\": \"AA\",\n \"value\": 69\n \
\ },\n {\n \"label\": \"A\",\n \
\ \"value\": 68\n },\n {\n \"label\"\
: \"عملاء\",\n \"value\": 67\n },\n {\n \
\ \"label\": \"r\",\n \"value\": 66\n \
\ },\n {\n \"label\": \"GameChangers\",\n \
\ \"value\": 65\n },\n {\n \"label\"\
: \"test109\",\n \"value\": 64\n },\n {\n\
\ \"label\": \"ahmedtest1\",\n \"value\": 63\n \
\ },\n {\n \"label\": \"test2seg\",\n \
\ \"value\": 62\n },\n {\n \"\
label\": \"ahmedtestadd\",\n \"value\": 61\n },\n \
\ {\n \"label\": \"asd\",\n \"value\": 58\n\
\ },\n {\n \"label\": \"asd1\",\n \
\ \"value\": 57\n },\n {\n \"\
label\": \"test1asd\",\n \"value\": 56\n },\n \
\ {\n \"label\": \"ImportantClients\",\n \"value\"\
: 55\n },\n {\n \"label\": \"all-87\",\n\
\ \"value\": 54\n },\n {\n \
\ \"label\": \"15\",\n \"value\": 53\n },\n \
\ {\n \"label\": \"test-45\",\n \"value\": 52\n\
\ },\n {\n \"label\": \"test_with_mo\",\n\
\ \"value\": 51\n },\n {\n \
\ \"label\": \"new_test\",\n \"value\": 50\n },\n \
\ {\n \"label\": \"VIB\",\n \"value\"\
: 49\n },\n {\n \"label\": \"tes\",\n \
\ \"value\": 48\n },\n {\n \
\ \"label\": \"ghadeer\",\n \"value\": 47\n },\n \
\ {\n \"label\": \"خدمةعملاء\",\n \"value\"\
: 46\n },\n {\n \"label\": \"sdafsafsfasdf\"\
,\n \"value\": 44\n },\n {\n \
\ \"label\": \"gsadfasfdasfasdfasdf\",\n \"value\": 40\n \
\ },\n {\n \"label\": \"customer\",\n \
\ \"value\": 36\n },\n {\n \"label\"\
: \"new\",\n \"value\": 35\n },\n {\n \
\ \"label\": \"test00\",\n \"value\": 34\n \
\ },\n {\n \"label\": \"VIP\",\n \"\
value\": 32\n },\n {\n \"label\": \"Yazeedn\"\
,\n \"value\": 28\n },\n {\n \
\ \"label\": \"س\",\n \"value\": 27\n },\n \
\ {\n \"label\": \"test0\",\n \"value\": 23\n\
\ },\n {\n \"label\": \"Te\",\n \
\ \"value\": 21\n },\n {\n \"label\"\
: \"Test\",\n \"value\": 20\n },\n {\n \
\ \"label\": \"GHANDI_TEST\",\n \"value\": 18\n \
\ },\n {\n \"label\": \"Test3\",\n \
\ \"value\": 17\n },\n {\n \"label\"\
: \"Test2\",\n \"value\": 14\n },\n {\n \
\ \"label\": \"Test1\",\n \"value\": 13\n \
\ }\n ]\n },\n {\n \"id\": 56,\n \"name\"\
: \"data_source\",\n \"selection_attribute\": \"multi-select\",\n \"\
content_source\": \"database_content\",\n \"placeholder\": null,\n \"\
locale_source\": \"front-end\",\n \"default_value\": null,\n \"priority\"\
: \"2\",\n \"options\": [\n {\n \"label\": \"\
twitter\",\n \"value\": 1\n },\n {\n \
\ \"label\": \"facebook\",\n \"value\": 2\n \
\ },\n {\n \"label\": \"instagram\",\n \
\ \"value\": 3\n },\n {\n \"label\"\
: \"intercom\",\n \"value\": 6\n },\n {\n\
\ \"label\": \"gmail\",\n \"value\": 7\n \
\ },\n {\n \"label\": \"whatsapp\",\n \
\ \"value\": 9\n },\n {\n \"label\"\
: \"survey\",\n \"value\": 14\n },\n {\n\
\ \"label\": \"genesys\",\n \"value\": 27\n \
\ },\n {\n \"label\": \"linkedin\",\n \
\ \"value\": 20\n },\n {\n \"label\"\
: \"googlemybusiness\",\n \"value\": 15\n },\n \
\ {\n \"label\": \"tiktok\",\n \"value\": 38\n\
\ }\n ]\n },\n {\n \"id\": 59,\n \
\ \"name\": \"location\",\n \"selection_attribute\": \"multi-select\",\n \
\ \"content_source\": \"engine_dynamic_api\",\n \"placeholder\": null,\n\
\ \"locale_source\": null,\n \"default_value\": null,\n \"\
priority\": \"3\",\n \"options\": [\n {\n \"\
label\": \"SA\",\n \"value\": \"SA\"\n },\n \
\ {\n \"label\": \"CO\",\n \"value\": \"CO\"\n \
\ },\n {\n \"label\": \"LY\",\n \
\ \"value\": \"LY\"\n },\n {\n \"\
label\": \"MY\",\n \"value\": \"MY\"\n },\n \
\ {\n \"label\": \"ES\",\n \"value\": \"ES\"\n \
\ },\n {\n \"label\": \"NG\",\n \
\ \"value\": \"NG\"\n },\n {\n \"\
label\": \"ZA\",\n \"value\": \"ZA\"\n },\n \
\ {\n \"label\": \"TZ\",\n \"value\": \"TZ\"\n \
\ },\n {\n \"label\": \"CU\",\n \
\ \"value\": \"CU\"\n },\n {\n \"\
label\": \"IN\",\n \"value\": \"IN\"\n },\n \
\ {\n \"label\": \"CA\",\n \"value\": \"CA\"\n \
\ },\n {\n \"label\": \"SN\",\n \
\ \"value\": \"SN\"\n },\n {\n \"\
label\": \"TR\",\n \"value\": \"TR\"\n },\n \
\ {\n \"label\": \"PT\",\n \"value\": \"PT\"\n \
\ },\n {\n \"label\": \"QA\",\n \
\ \"value\": \"QA\"\n },\n {\n \"\
label\": \"IT\",\n \"value\": \"IT\"\n },\n \
\ {\n \"label\": \"KE\",\n \"value\": \"KE\"\n \
\ },\n {\n \"label\": \"KW\",\n \
\ \"value\": \"KW\"\n },\n {\n \"\
label\": \"IQ\",\n \"value\": \"IQ\"\n },\n \
\ {\n \"label\": \"EG\",\n \"value\": \"EG\"\n \
\ },\n {\n \"label\": \"US\",\n \
\ \"value\": \"US\"\n },\n {\n \"\
label\": \"EC\",\n \"value\": \"EC\"\n },\n \
\ {\n \"label\": \"GH\",\n \"value\": \"GH\"\n \
\ },\n {\n \"label\": \"AE\",\n \
\ \"value\": \"AE\"\n },\n {\n \"\
label\": \"NI\",\n \"value\": \"NI\"\n },\n \
\ {\n \"label\": \"JO\",\n \"value\": \"JO\"\n \
\ },\n {\n \"label\": \"PY\",\n \
\ \"value\": \"PY\"\n },\n {\n \"\
label\": \"BH\",\n \"value\": \"BH\"\n },\n \
\ {\n \"label\": \"ID\",\n \"value\": \"ID\"\n \
\ },\n {\n \"label\": \"BR\",\n \
\ \"value\": \"BR\"\n },\n {\n \"\
label\": \"UG\",\n \"value\": \"UG\"\n },\n \
\ {\n \"label\": \"DE\",\n \"value\": \"DE\"\n \
\ },\n {\n \"label\": \"PH\",\n \
\ \"value\": \"PH\"\n },\n {\n \"\
label\": \"AR\",\n \"value\": \"AR\"\n },\n \
\ {\n \"label\": \"GB\",\n \"value\": \"GB\"\n \
\ },\n {\n \"label\": \"YE\",\n \
\ \"value\": \"YE\"\n },\n {\n \"\
label\": \"MR\",\n \"value\": \"MR\"\n },\n \
\ {\n \"label\": \"UA\",\n \"value\": \"UA\"\n \
\ },\n {\n \"label\": \"FR\",\n \
\ \"value\": \"FR\"\n },\n {\n \"\
label\": \"SD\",\n \"value\": \"SD\"\n },\n \
\ {\n \"label\": \"OM\",\n \"value\": \"OM\"\n \
\ },\n {\n \"label\": \"BW\",\n \
\ \"value\": \"BW\"\n },\n {\n \"\
label\": \"AU\",\n \"value\": \"AU\"\n },\n \
\ {\n \"label\": \"DZ\",\n \"value\": \"DZ\"\n \
\ },\n {\n \"label\": \"PK\",\n \
\ \"value\": \"PK\"\n },\n {\n \"\
label\": \"GQ\",\n \"value\": \"GQ\"\n },\n \
\ {\n \"label\": \"MV\",\n \"value\": \"MV\"\n \
\ },\n {\n \"label\": \"MX\",\n \
\ \"value\": \"MX\"\n },\n {\n \"\
label\": \"ET\",\n \"value\": \"ET\"\n },\n \
\ {\n \"label\": \"CD\",\n \"value\": \"CD\"\n \
\ },\n {\n \"label\": \"CH\",\n \
\ \"value\": \"CH\"\n },\n {\n \"\
label\": \"HT\",\n \"value\": \"HT\"\n },\n \
\ {\n \"label\": \"CN\",\n \"value\": \"CN\"\n \
\ },\n {\n \"label\": \"PE\",\n \
\ \"value\": \"PE\"\n },\n {\n \"\
label\": \"ME\",\n \"value\": \"ME\"\n },\n \
\ {\n \"label\": \"BE\",\n \"value\": \"BE\"\n \
\ },\n {\n \"label\": \"NL\",\n \
\ \"value\": \"NL\"\n },\n {\n \"\
label\": \"BF\",\n \"value\": \"BF\"\n },\n \
\ {\n \"label\": \"HU\",\n \"value\": \"HU\"\n \
\ },\n {\n \"label\": \"ZW\",\n \
\ \"value\": \"ZW\"\n },\n {\n \"\
label\": \"AF\",\n \"value\": \"AF\"\n },\n \
\ {\n \"label\": \"RW\",\n \"value\": \"RW\"\n \
\ },\n {\n \"label\": \"KR\",\n \
\ \"value\": \"KR\"\n },\n {\n \"\
label\": \"RU\",\n \"value\": \"RU\"\n },\n \
\ {\n \"label\": \"PS\",\n \"value\": \"PS\"\n \
\ },\n {\n \"label\": \"CL\",\n \
\ \"value\": \"CL\"\n },\n {\n \"\
label\": \"MA\",\n \"value\": \"MA\"\n },\n \
\ {\n \"label\": \"AO\",\n \"value\": \"AO\"\n \
\ },\n {\n \"label\": \"VE\",\n \
\ \"value\": \"VE\"\n },\n {\n \"\
label\": \"JP\",\n \"value\": \"JP\"\n },\n \
\ {\n \"label\": \"GT\",\n \"value\": \"GT\"\n \
\ },\n {\n \"label\": \"CM\",\n \
\ \"value\": \"CM\"\n },\n {\n \"\
label\": \"JE\",\n \"value\": \"JE\"\n },\n \
\ {\n \"label\": \"CZ\",\n \"value\": \"CZ\"\n \
\ },\n {\n \"label\": \"AZ\",\n \
\ \"value\": \"AZ\"\n },\n {\n \"\
label\": \"KP\",\n \"value\": \"KP\"\n },\n \
\ {\n \"label\": \"SV\",\n \"value\": \"SV\"\n \
\ },\n {\n \"label\": \"LB\",\n \
\ \"value\": \"LB\"\n },\n {\n \"\
label\": \"GM\",\n \"value\": \"GM\"\n },\n \
\ {\n \"label\": \"NZ\",\n \"value\": \"NZ\"\n \
\ },\n {\n \"label\": \"SY\",\n \
\ \"value\": \"SY\"\n },\n {\n \"\
label\": \"CG\",\n \"value\": \"CG\"\n },\n \
\ {\n \"label\": \"DJ\",\n \"value\": \"DJ\"\n \
\ },\n {\n \"label\": \"NO\",\n \
\ \"value\": \"NO\"\n },\n {\n \"\
label\": \"AQ\",\n \"value\": \"AQ\"\n },\n \
\ {\n \"label\": \"PR\",\n \"value\": \"PR\"\n \
\ },\n {\n \"label\": \"IE\",\n \
\ \"value\": \"IE\"\n },\n {\n \"\
label\": \"IL\",\n \"value\": \"IL\"\n },\n \
\ {\n \"label\": \"VN\",\n \"value\": \"VN\"\n \
\ },\n {\n \"label\": \"GE\",\n \
\ \"value\": \"GE\"\n },\n {\n \"\
label\": \"UY\",\n \"value\": \"UY\"\n },\n \
\ {\n \"label\": \"BM\",\n \"value\": \"BM\"\n \
\ },\n {\n \"label\": \"NP\",\n \
\ \"value\": \"NP\"\n },\n {\n \"\
label\": \"CR\",\n \"value\": \"CR\"\n },\n \
\ {\n \"label\": \"LK\",\n \"value\": \"LK\"\n \
\ },\n {\n \"label\": \"MZ\",\n \
\ \"value\": \"MZ\"\n },\n {\n \"\
label\": \"ML\",\n \"value\": \"ML\"\n },\n \
\ {\n \"label\": \"TH\",\n \"value\": \"TH\"\n \
\ },\n {\n \"label\": \"GR\",\n \
\ \"value\": \"GR\"\n },\n {\n \"\
label\": \"GN\",\n \"value\": \"GN\"\n },\n \
\ {\n \"label\": \"MW\",\n \"value\": \"MW\"\n \
\ },\n {\n \"label\": \"DO\",\n \
\ \"value\": \"DO\"\n },\n {\n \"\
label\": \"VU\",\n \"value\": \"VU\"\n },\n \
\ {\n \"label\": \"SO\",\n \"value\": \"SO\"\n \
\ },\n {\n \"label\": \"SI\",\n \
\ \"value\": \"SI\"\n },\n {\n \"\
label\": \"PG\",\n \"value\": \"PG\"\n }\n ]\n\
\ },\n {\n \"id\": 23,\n \"name\": \"gender\",\n \
\ \"selection_attribute\": \"checkbox-labels\",\n \"content_source\": \"\
static_content\",\n \"placeholder\": null,\n \"locale_source\": null,\n\
\ \"default_value\": null,\n \"priority\": \"4\",\n \"options\"\
: [\n {\n \"value\": \"m\",\n \"color\"\
: \"blue\",\n \"label\": \"Male\"\n },\n \
\ {\n \"value\": \"f\",\n \"color\": \"blue\",\n \
\ \"label\": \"Female\"\n }\n ]\n },\n \
\ {\n \"id\": 42,\n \"name\": \"themes\",\n \"selection_attribute\"\
: \"multi-select\",\n \"content_source\": \"engine_dynamic_api\",\n \
\ \"placeholder\": null,\n \"locale_source\": null,\n \"default_value\"\
: null,\n \"priority\": \"5\",\n \"options\": [\n {\n\
\ \"label\": \"Question\",\n \"value\": \"Question\"\
\n },\n {\n \"label\": \"Complaint\",\n \
\ \"value\": \"Complaint\"\n },\n {\n \
\ \"label\": \"Complement\",\n \"value\": \"Complement\"\
\n },\n {\n \"label\": \"Other\",\n \
\ \"value\": \"Other\"\n }\n ]\n },\n \
\ {\n \"id\": 43,\n \"name\": \"sub_themes\",\n \"selection_attribute\"\
: \"multi-select\",\n \"content_source\": \"engine_dynamic_api\",\n \
\ \"placeholder\": null,\n \"locale_source\": null,\n \"default_value\"\
: null,\n \"priority\": \"6\",\n \"options\": [\n {\n\
\ \"label\": \"Products & Services\",\n \"value\": \"\
Products & Services\"\n },\n {\n \"label\"\
: \"Delivery\",\n \"value\": \"Delivery\"\n },\n \
\ {\n \"label\": \"Portal/App\",\n \"value\"\
: \"Portal/App\"\n },\n {\n \"label\": \"\
Payment\",\n \"value\": \"Payment\"\n },\n \
\ {\n \"label\": \"Customer Services\",\n \"value\"\
: \"Customer Services\"\n },\n {\n \"label\"\
: \"Undefined\",\n \"value\": \"Undefined\"\n }\n \
\ ]\n },\n {\n \"id\": 25,\n \"name\": \"dialects\"\
,\n \"selection_attribute\": \"multi-select\",\n \"content_source\"\
: \"engine_dynamic_api\",\n \"placeholder\": null,\n \"locale_source\"\
: null,\n \"default_value\": null,\n \"priority\": \"7\",\n \
\ \"options\": [\n {\n \"label\": \"saudi\",\n \
\ \"value\": \"saudi\",\n \"stats_count\": \"\"\n \
\ },\n {\n \"label\": \"khaleji\",\n \
\ \"value\": \"khaleji\",\n \"stats_count\": \"\"\n \
\ },\n {\n \"label\": \"egyptian\",\n \
\ \"value\": \"egyptian\",\n \"stats_count\": \"\"\n \
\ },\n {\n \"label\": \"modern ar\",\n \
\ \"value\": \"modern ar\",\n \"stats_count\": \"\"\n \
\ },\n {\n \"label\": \"iraqi\",\n \"\
value\": \"iraqi\",\n \"stats_count\": \"\"\n },\n \
\
# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lucidya-ltd/refs/heads/main/openapi/lucidya-ltd-cdp-api-openapi.yml