Configuration

Configuration API returns possible filter values to perform calls on an activated {licence_id}.

Please Note

In order to apply changes to the current configuration, please contact customer support.

Request

Endpoint

GET /v4/licence/{licence_id}/territorial/configuration

Path Parameters

Name	Description	Type	Examples
*{licence_id}	Identifier of the licence.	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}

Example

curl -X GET 'https://api.datappeal.io/v4/licence/{licence_id}/territorial/configuration' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status	Description
200	Configuration data has been successfully returned.

Body

Configuration

Field	Description	Type
*areas	Details about configured areas configured for {licence_id}.	ConfigurationAreas
reputation	Details about Reputation section configured for {licence_id}.	ConfigurationSection
rates	Details about Rates section configured for {licence_id}.	ConfigurationSection
sustainability	Details about Sustainability section configured for {licence_id}.	ConfigurationSection

ConfigurationAreas

Field	Description	Type
*main	Identifier of the entity to be filtered.	ConfigurationArea
*sublocations	Descriptive name of the entity to be filtered.	array[ConfigurationArea]
*competitors	Children entities of the entity to be filtered.	array[ConfigurationArea]

ConfigurationArea

Field	Description	Type	Examples
*id	Identifier of the area.	string	AbCd12ef34ghi56lmn78op
*name	Descriptive name of the area.	string	Veneto
*type	Area perimeter delimitation type.	string	locations_validated polygon point_radius
geometry_id	Identifier of the geometry: required when "type": "polygon".	string	1a2b3v4d5e6f7g8h9i0l1m2n3o4p5
country	Identifier of the country: required when "type": "locations_validated".	string	italy
state	Identifier of the state: may be set when "type": "locations_validated".	string	veneto
county	Identifier of the county: may be set when "type": "locations_validated".	string	venezia
city	Identifier of the city: may be set when "type": "locations_validated".	string	portogruaro
latitude	Latitude of the circle center: required when "type": "point_radius".	decimal	43.770366014832014
longitude	Longitude of the circle center: required when "type": "point_radius".	decimal	11.257818620617464
radius	Circle radius length in km: required when "type": "point_radius".	decimal	40

Supported values for type

• locations_validated
• polygon
• point_radius

ConfigurationSection

Field	Description	Type
*timeframe	Minimum and maximum date allowed.	TimeframeBoundaries
industry_categories	List of configured industries and categories.	array[ConfigurationFilter]
nets	List of configured nets of POIs.	array[ConfigurationFilter]
origin_market	List of configured origin market countries.	array[ConfigurationFilter]

TimeframeBoundaries

Field	Description	Type
*min_date	Minimum allowed date.	date
*max_date	Maximum allowed date.	date

ConfigurationFilter

Field	Description	Type	Examples
*id	Identifier of the entity to be filtered.	string	AbCd12ef34ghi56lmn78op
name	Descriptive name of the entity to be filtered.	string	Veneto
children	Children entities of the entity to be filtered.	array[ConfigurationFilter]

Configuration

{
  "areas": {
    "main": {
      "id": "AbCd12ef34ghi56lmn78op",
      "name": "Veneto",
      "type": "locations_validated",
      "country": "italy",
      "state": "veneto"
    },
    "sublocations": [
      {
        "id": "venezia",
        "name": "Venezia",
        "type": "polygon",
        "geometry_id": "1a2b3v4d5e6f7g8h9i0l1m2n3o4p5q6r7s8t9u0v1w1s2y3z41a2b3v4d5e67g8h"
      },
      {
        "id": "cortina",
        "name": "Cortina",
        "type": "polygon",
        "geometry_id": "2a2b3v4d5e6f7g8h9i0l1m2n3o4p5q6r7s8t9u0v1w1s2y3z41a2b3v4d5e67g8h"
      }
    ],
    "competitors": [
      {
        "id": "trentino",
        "name": "Trentino",
        "type": "polygon",
        "geometry_id": "3a2b3v4d5e6f7g8h9i0l1m2n3o4p5q6r7s8t9u0v1w1s2y3z41a2b3v4d5e67g8h"
      },
      {
        "id": "friuli-venezia-giulia",
        "name": "Friuli Venezia Giulia",
        "type": "polygon",
        "geometry_id": "4a2b3v4d5e6f7g8h9i0l1m2n3o4p5q6r7s8t9u0v1w1s2y3z41a2b3v4d5e67g8h"
      }
    ]
  },
  "reputation": {
    "timeframe": {
      "min_date": "2018-12-31",
      "max_date": "2026-05-15"
    },
    "industry_categories": [
      {
        "id": "agriculture",
        "children": [
          {
            "id": "agriculture-winery"
          },
          {
            "id": "farm"
          }
        ]
      },
      {
        "id": "attractions",
        "children": [
          {
            "id": "aquarium"
          },
          {
            "id": "archaeological_area"
          }
        ]
      }
    ],
    "origin_market": [
      {
        "id": "at"
      },
      {
        "id": "ch"
      }
    ]
  },
  "rates": {
    "timeframe": {
      "min_date": "2021-12-31",
      "max_date": "2027-05-22"
    },
    "industry_categories": [
      {
        "id": "hospitality",
        "children": [
          {
            "id": "hostel"
          },
          {
            "id": "hotel"
          }
        ]
      },
      {
        "id": "short_term_rentals",
        "children": [
          {
            "id": "house_flat"
          },
          {
            "id": "room_rental"
          }
        ]
      }
    ]
  },
  "sustainability": {
    "timeframe": {
      "min_date": "2018-12-31",
      "max_date": "2026-04-30"
    }
  }
}