▪ Cluster

Cluster API returns a list of all recorded clusters.
A cluster identifies a super-set of topics which have similar argument pertinence.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/dictionary/cluster

Path Parameters

Name	Description	Type	Examples
*{billing_plan}	Billing plan to be applied to the call.	string	licence ondemand
*{account_id}	Provided identifier of the account.	string

Header Parameters

Name	Description	Type	Examples	Default
*x-api-key	Provided API key {x_api_key} that allows authentication.	string
*Authorization	Provided token {jwt_bearer} that allows authorization.	string	Bearer {jwt_bearer}
Accept-Language	Translate the requested dictionary entries in a language specified in in ISO_639-1 standard format.	string	it fr	en

                                                                                                                                    | Translate the requested dictionary entries in a language specified in [ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1){target=_blank} standard format. | _string_ | it</br>fr                                                                                                                                                      | en      |

Query Parameters

Name	Description	Type	Examples	Default
page	Requested page number for paginated results.	int		1
page_size	Requested page size for paginated results in the range [1, 100].	int		25

Example

curl -X GET 'https://api.datappeal.io/v4/{billing_plan}/account/{account_id}/dictionary/cluster?page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status	Description
200	Cluster data has been successfully returned.

Body

Clusters

Field	Description	Type
*results	Paginated list of clusters.	array[DictionaryEntry]
paging	Response pagination.	Paging

DictionaryEntry

Field	Description	Type	Examples
*id	Descriptive identifier of the entry.	string	accessibility family accounting apartments agriculture
*name	Full name of the entry.	string	Accessibility Families Accounting Apartments Agriculture
*assets	Set of images related to the entry.	Assets

Assets

Field	Description	Type	Examples
*icon	Icon corresponding to the parent entry.	Icon

Icon

Field	Description	Type	Examples
*material_io	Material Icon identifier.	string	loyalty favorite storefront house agriculture

Paging

Field	Description	Type
last	A relative URI to the last page.	string
first	A relative URI to the first page.	string
prev	A relative URI to the previous page.	string
next	A relative URI to the next page.	string
current	A relative URI to the current page.	string
pages	A set of relative URIs calculated around the current page.	Page
elements	All indexes shown on the current page.	array[int]
total	The number of all elements that API can retrieve.	int
size	The selected page size.	int

Page

Field	Description	Type
number	Number of the page.	int
uri	URI of the page.	string

Example

{
    "results": [
        {
            "id": "accessibility",
            "name": "Accessibility",
            "assets": {
                "icon": {
                    "material_io": "loyalty"
                }
            }
        },
        {
            "id": "accomodation",
            "name": "Accomodation",
            "assets": {
                "icon": {
                    "material_io": "loyalty"
                }
            }
        }
    ],
   "paging": {
        "last": "/dictionary/network?page=24&page_size=2",
        "first": "/dictionary/network?page=1&page_size=2",
        "prev": null,
        "next": "/dictionary/network?page=2&page_size=2",
        "current": "/dictionary/network?page=1&page_size=2",
        "pages": [
            {
                "number": 1,
                "uri": "/dictionary/network?page=1&page_size=2"
            },
            {
                "number": 2,
                "uri": "/dictionary/network?page=2&page_size=2"
            },
            {
                "number": 3,
                "uri": "/dictionary/network?page=3&page_size=2"
            },
            {
                "number": 4,
                "uri": "/dictionary/network?page=4&page_size=2"
            },
            {
                "number": 5,
                "uri": "/dictionary/network?page=5&page_size=2"
            }
        ],
        "elements": [
            1,
            2
        ],
        "total": 47,
        "size": 2
    }
}