▪ LGBTQ+ Series

LGBTQ+ Series API returns a time-based index score series for the specified POI, grouped by a time period.

Request

Endpoint

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

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
*from	Start date of timeframe.	date	2020-01-01
*to	End date of timeframe.	date	2020-12-31
*period	Time unit of the series.	string	day week month

Supported values for period

• week
• month

Example

curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/XXeUNbmtYZTsH7UGvNfXWo/index/lgbtq/overall/series?from=2021-01-01&to=2021-01-31&period=week' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status	Description
200	LGBTQ+ Series data has been successfully returned.

Body

SeriesIndex

Field	Description	Type
series	Index series data for the requested timeframe and period.	array[SeriesIndexElement]

SeriesIndexElement

Field	Description	Type
*period	Date representing a specific day, corresponding to the first day of the requested period. day: the day itself. week: first day of the corresponding week. month: first day of the corresponding month.	date
*value	Index score of corresponding period.	IndexScore

IndexScore

Field	Description	Type
score	Index score value in the range [0,100].	decimal

Example

{
    "series": [
        {
            "period": "2021-01-04",
            "value": {
                "score": 24.94
            }
        },
        {
            "period": "2021-01-11",
            "value": {
                "score": 26.38
            }
        },
        {
            "period": "2021-01-18",
            "value": {
                "score": 30.21
            }
        },
        {
            "period": "2021-01-25",
            "value": {
                "score": 26.97
            }
        }
    ]
}