Parity Timeline

A Timeline of Direct Prices Being Undercut by Online Travel Agencies (OTAs)

GET https://api.rateparity.com/v1/insights/paritytimeline/{code}

By default the timeline period to search is 7 days (last week). Search for a custom period is also available for a maximum of 31 days.

Path Parameters

Name	Type	Description
code*	String	The property code

Query Parameters

Name	Type	Description
from	Date	Search from date (ISO 8601). Defaults to today minus 7 days
to	Date	Search to date (ISO 8601). Defaults to today - 1 days

200: OK Everything worked as expected

{
    "data": [
        {
            "date": "2023-04-01",
            "visits": 1606,
            "disparities": 907,
            "conversion": 57.0
        },
        {
            "date": "2023-04-02",
            "visits": 1823,
            "disparities": 191,
            "conversion": 11.0
        },
        {
            "date": "2023-04-03",
            "visits": 1685,
            "disparities": 432,
            "conversion": 26.0
        },
        {
            "date": "2023-04-04",
            "visits": 1336,
            "disparities": 309,
            "conversion": 24.0
        }
    ],
    "summary": {
        "visits": 6450.0,
        "disparities": 1839.0,
        "conversion": 29.0
    }
}

400: Bad Request Period is more than 31 days or invalid (i.e. to date is earlier than from date)

401: Unauthorized No valid API key provided or not authorised to access the provided property code

Example

curl

curl 'https://api.rateparity.com/v1/insights/paritytimeline/LAURA?from=2023-03-01&to=2023-03-03' \
--header 'Authorization: Bearer YOUR_API_KEY'

{
    "data": [
        {
            "date": "2023-03-01",
            "visits": 474,
            "disparities": 250,
            "conversion": 53.0
        },
        {
            "date": "2023-03-02",
            "visits": 766,
            "disparities": 239,
            "conversion": 32.0
        },
        {
            "date": "2023-03-03",
            "visits": 820,
            "disparities": 360,
            "conversion": 44.0
        }
    ],
    "summary": {
        "visits": 2060.0,
        "disparities": 849.0,
        "conversion": 42.0
    }
}