Skip to content

▪ LGBTQ+

Pricing Tier Licence Type

LGBTQ+ API returns the index score for the specified POI.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/poi/{poi_id}/index/lgbtq/overall

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
*{poi_id} Identifier of the POI to retrieve data for.
Value obtainable either :
- if {billing_plan}= licence, from $.results[*].resource.id field of List Licences Response Body
- if {billing_plan}= ondemand, from $.results.pois[*].id field of any Search API Response Body.		 string XXeUNbmtYZTsH7UGvNfXWo

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
*date Day for which index score is requested. date 2021-01-31
Example 
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/XXeUNbmtYZTsH7UGvNfXWo/index/lgbtq/overall?date=2021-01-31' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 LGBTQ+ data has been successfully returned.

Body

IndexDateScore

Field Description Type
date Date representing the day score refers to.
It could differ by the requested date for calculation resolution reasons.		 date
score Index score value in the range [0,100]. decimal
Example 
{
    "date": "2021-01-31",
    "score": 28.06
}