Skip to content

Network

Network API returns a list of all recorded networks.
A network identifies a web platform that users can feed with contents of judgement.

Request

Endpoint

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

Path Parameters

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

Header Parameters

Name                          Description Type Examples                         
*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}

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/network?page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Network data has been successfully returned.

Body

Networks

Field Description Type
*results Paginated list of networks. array[Network]
paging Response pagination. Paging
Network
Field Description Type Examples
*id Descriptive identifier of the network. string booking
name Full name of the network. string Booking.com
color Proposed HTML Hex Color Code representing the network. string #00ACEE
max_rating Maximum possible rating score a user can assign within the network. int 10
*channel_type List of platform typologies the network belongs to. array[string] ["social","review"]
*assets Set of images related to the network. NetworkAssets
NetworkAssets
Field Description Type Examples
img Logo of the network. string https://static.travelappeal.com/img/common/network_with_background/png/booking.png
*rating_icons Icons expressing rating polarity. RatingIcons
RatingIcons
Field Description Type Examples
full Icon representing positive rating. string https://static.travelappeal.com/img/common/network_ranking_icons/star_full.png
half Icon representing neutral rating. string https://static.travelappeal.com/img/common/network_ranking_icons/star_half.png
empty Icon representing negative rating. string https://static.travelappeal.com/img/common/network_ranking_icons/star_empty.png
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": "booking",
            "name": "Booking.com",
            "color": "#00acee",
            "max_rating": 10,
            "channel_type": [
                "review"
            ],
            "assets": {
                "img": "https://static.travelappeal.com/img/common/network_with_background/png/booking.png",
                "rating_icons": {
                    "full": "https://static.travelappeal.com/img/common/network_ranking_icons/star_full.png",
                    "half": "https://static.travelappeal.com/img/common/network_ranking_icons/star_half.png",
                    "empty": "https://static.travelappeal.com/img/common/network_ranking_icons/star_empty.png"
                }
            }
        },
        {
            "id": "facebook",
            "name": "Facebook",
            "color": "#3c4f99",
            "max_rating": 5,
            "channel_type": [
                "social",
                "review"
            ],
            "assets": {
                "img": "https://static.travelappeal.com/img/common/network_with_background/png/facebook.png",
                "rating_icons": {
                    "full": "https://static.travelappeal.com/img/common/network_ranking_icons/star_full.png",
                    "half": "https://static.travelappeal.com/img/common/network_ranking_icons/star_half.png",
                    "empty": "https://static.travelappeal.com/img/common/network_ranking_icons/star_empty.png"
                }
            }
        }
    ],
    "paging": {
        "last": "/dictionary/network?page=40&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": 79,
        "size": 2
    }
}