I/O Docs: API Documentation (SEE IMPORTANT UTF-8 NOTE BELOW)

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Account

  • List Methods
  • Expand Methods

  • GET Lodgings (pid) For Account Lookup /v1/account/lodgings

    Look up all available pids (hotel or restaurants ids) for your account

    Parameter	Value	Type	Description
    productType	HOTEL RESTAURANT	string	The product type

  • GET Competitors for Account /v1/account/lodgings/competitors

    Look up competitors (id and name) for one or several pids of your account

    Parameter	Value	Type	Description
    pid		int	The lodging's product id (maximum of 10 per request)

  • GET Groups for Account /v1/account/groups/:gid

    Look up all pids of one or several groups related to your account

    Parameter	Value	Type	Description
    :gid		string	The list of group ids

  • GET All Groups for Account /v1/account/groups

    Look up all pids of all groups related to your account

• Lodging GRI and Source Rating Indexes

  • List Methods
  • Expand Methods

  • GET Daily Index for Rating in Period /v1/lodging/index/daily

    Returns the daily time series index data for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Competitors Daily Index for Rating in Period /v1/lodging/index/daily

    Returns the daily time series index data for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    cid		int	The competitors lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Average Index for Rating in Period /v1/lodging/index/avg

    Returns the average value for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Competitors Average Index for Rating in Period /v1/lodging/index/avg

    Returns the average value for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    cid		int	The competitors lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Daily Index for Rating in Period (PMS) /v1/lodging/index/daily

    Returns the daily time series index data for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pmsId		string	The lodging's external PMS id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Brand competition /v1/group/review/brandCompetition

    Returns the brand competition for the specified group

    Parameter	Value	Type	Description
    gid		int	The group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• Average scores

  • List Methods
  • Expand Methods

  • GET Daily Average for index type (Product) /v1/lodging/avg/daily

    Returns the daily time series index data for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Daily Average for index type (Group) /v1/group/avg/daily

    Returns the average value for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    gid		int	The group's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• GRS Rating Indexes

  • List Methods
  • Expand Methods

  • GET Daily Index for Rating in Period /v1/lodging/grs/daily

    Returns the daily time series index data for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Average Index for Rating in Period /v1/lodging/grs/avg

    Returns the average value for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET GRS distribution for date range /v1/lodging/grs/distribution

    Returns the average value for selected the lodging and rating type in the given date range.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• Group Rating Indexes

  • List Methods
  • Expand Methods

  • GET Daily Index for Rating in Period /v1/group/index/daily

    Return index data for a given group and index type

    Parameter	Value	Type	Description
    gid		int	The group's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Average Index for Rating in Period /v1/group/index/avg

    Return index data for a given group and index type

    Parameter	Value	Type	Description
    gid		int	The group's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• Lodging Rating Distribution

  • List Methods
  • Expand Methods

  • GET Rating Distribution /v1/lodging/review/rating/distribution

    Fetch the distribution of positive, neutral and negative reviews for the lodging in the date range for a specified rating type.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    gid		int	The lodging's group id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Competitors Rating Distribution /v1/lodging/review/rating/distribution

    Fetch the distribution of positive, neutral and negative reviews for the lodging in the date range for a specified rating type.

    Parameter	Value	Type	Description
    cid		int	The competitors lodging's product id
    rt	OVERALL SERVICE CLEANLINESS LOCATION VALUE GASTRONOMY ROOM DECORATION BUSINESS RECEPTION ENTERTAINMENT	string	The rating type
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Language Distribution /v1/lodging/review/language/distribution

    Fetch the distribution of positive, neutral and negative reviews for the lodging in the date range for a specified language.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    lang		string	2-letter ISO code
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Country Distribution - Lodging /v1/lodging/review/country/distribution

    Fetch the distribution by country of positive, neutral and negative reviews for the lodging in the date range for specified countries.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    countries		string	2-letter ISO code such as US,GB,ES,FR,IT...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Country Distribution - Group /v1/group/review/country/distribution

    Fetch the distribution of country positive, neutral and negative reviews for the group in the date range for specified countries.

    Parameter	Value	Type	Description
    gid		int	The group id
    countries		string	2-letter ISO code such as US,GB,ES,FR,IT...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Competitors Language Distribution /v1/lodging/review/language/distribution

    Fetch the distribution of positive, neutral and negative reviews for the lodging in the date range for a specified language.

    Parameter	Value	Type	Description
    cid		int	The competitors lodging's product id
    lang		string	2-letter ISO code
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Country Index - Lodging /v1/lodging/review/country/index

    Fetch the index by country of reviews for the lodging in the date range for specified countries.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    countries		string	2-letter ISO code such as US,GB,ES,FR,IT...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Triptype Index - Lodging /v1/lodging/review/tripType/index

    Fetch the index by triptype of reviews for the lodging in the date range for specified triptypes.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    tripTypes		string	The triptypes
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Country Index - Competitor /v1/lodging/review/country/index

    Fetch the index by country of reviews for a competitor in the date range for specified countries.

    Parameter	Value	Type	Description
    cid		int	The competitor's product id
    countries		string	2-letter ISO code such as US,GB,ES,FR,IT...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Country Index - Group /v1/group/review/country/index

    Fetch the index of country of reviews for the group in the date range for specified countries.

    Parameter	Value	Type	Description
    gid		int	The group id
    countries		string	2-letter ISO code such as US,GB,ES,FR,IT...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Triptype Index - Group /v1/group/review/tripType/index

    Fetch the index of triptype of reviews for the group in the date range for specified trip types.

    Parameter	Value	Type	Description
    gid		int	The group id
    tripTypes		string	The trip types
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Country Index - Competitor Group /v1/group/review/country/index

    Fetch the index of country of reviews for a competitor group in the date range for specified countries.

    Parameter	Value	Type	Description
    cgid		int	The competitor group id
    countries		string	2-letter ISO code such as US,GB,ES,FR,IT...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Language Index - Lodging /v1/lodging/review/language/index

    Fetch the index by country of reviews for the lodging in the date range for specified languages.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    langs		string	2-letter ISO code such as en,es,fr,it...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Language Index - Competitor /v1/lodging/review/language/index

    Fetch the index by country of reviews for a competitor in the date range for specified languages.

    Parameter	Value	Type	Description
    cid		int	The competitor's product id
    langs		string	2-letter ISO code such as en,es,fr,it...
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Reviews and Index distribution by trip type /v1/lodging/triptype/distribution

    Returns the daily time series index data and distribution for selected the lodging by trip type.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• Lodging CQI

  • List Methods
  • Expand Methods

  • GET CQI in Period /v1/lodging/index/cqi

    Returns the average CQI for a period and the evolution from the previous period

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    pids		string	The lodging's product ids
    fd		date	Start date of the period in the format yyyy-mm-dd e.g 2024-01-01
    td		date	End date of the period in the format yyyy-mm-dd e.g 2024-01-01

• Semantic

  • List Methods
  • Expand Methods

  • GET Semantic Concepts /v1/lodging/semantic/concepts

    Fetch ids and names of semantic concepts in the desired language. Available languages are: en, de, es, fr, pt, it, nl, zh, ru, th, id, ja, tr

    Parameter	Value	Type	Description
    lang		string	2-letter ISO code

  • GET Semantic Categories /v1/lodging/semantic/categories

    Fetch semantic categories and its concepts.

    Parameter	Value	Type	Description
    pt	ALL HOTEL RESTAURANT	string	Product type

  • GET Semantic Mentions /v1/lodging/semantic/mentions

    Fetch number of positive and negative mentions for each concept

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Semantic Mentions Details /v1/lodging/semantic/mentions/details

    Fetch mentions with full details

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    pids		string	The lodging's product ids
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01
    offset		integer	Index of the first response to be returned. Indexes start at 0.
    limit		integer	Number of responses to return. Must be greater than 0 and lesser than 1000.

  • GET Semantic Mentions Sources /v1/lodging/semantic/mentions/sources

    Fetch mentions sources

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Semantic Mentions Language /v1/lodging/semantic/mentions/language

    Fetch mentions language stats

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Semantic Mentions Categories /v1/lodging/semantic/mentions/categories

    Fetch mentions categories

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Categories decreasing GRI /v1/lodging/semantic/categoriesDecreasingGRI

    Categories decreasing GRI

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    pids		string	The lodging's product ids
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Categories increasing GRI /v1/lodging/semantic/categoriesIncreasingGRI

    Categories increasing GRI

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    pids		string	The lodging's product ids
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• Sources

  • List Methods
  • Expand Methods

  • GET Sources with Data for Product /v1/lodging/source/detail/product

    Fetch all source detail information for a given product (pid). Distribution will be provided as [positives, neutrals, negatives, unrated].

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Sources with Data for Competitor /v1/lodging/source/detail/product

    Fetch all source detail information for a given competitor (cid). Distribution will be provided as [positives, neutrals, negatives, unrated].

    Parameter	Value	Type	Description
    cid		int	The competitor product id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

• Reviews

  • List Methods
  • Expand Methods

  • GET Published Reviews /v1/lodging/review/published

    Fetch published reviews for given pid (lodging id)

    Parameter	Value	Type	Description
    pid		int	The lodging's product id

  • GET Review Management Responses /v1/lodging/review/responses

    Fetch summaries of Management Responses per source for given pid (lodging id). BE AWARE: Data from TripAdvisor can only be used for internal purposes.

    Parameter	Value	Type	Description
    pid		int	The lodging's product id -- this can be a comma seperated list if you want grouped data
    gid		int	The lodging's group id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Competitors Review Management Responses /v1/lodging/review/responses

    Fetch summaries of Management Responses per source for given cid (competitor lodging id). BE AWARE: Data from TripAdvisor can only be used for internal purposes.

    Parameter	Value	Type	Description
    cid		int	The competitor lodging's product id -- this can be a comma seperated list if you want grouped data
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01

  • GET Review Summaries /v1/lodging/review/summaries

    Fetch review summaries for given pid (lodging id)

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01
    rw		int	The max number of values to return in this query (100 max per request)
    st		int	The offset of values to return, used for paging over results

  • GET Private Reviews /v1/lodging/review/private

    Fetch private (CSQ not RP GSS) reviews for given pid (lodging id)

    Parameter	Value	Type	Description
    pid		int	The lodging's product id
    fd		date	The from date in the format yyyy-mm-dd e.g 2024-01-01
    td		date	The to date in the format yyyy-mm-dd e.g 2024-01-01
    rw		int	The max number of values to return in this query (100 max per request)
    st		int	The offset of values to return, used for paging over results

  • GET Recent Reviews /v1/lodging/review/recent

    Fetch recent reviews for given pid (lodging id). Please be aware that for the usage of this specific endpoint a surcharge applies!

    Parameter	Value	Type	Description
    pid		int	The lodging's product id

• Surveys

  • List Methods
  • Expand Methods

  • GET Lookup available surveys /v1/surveys

    Look up active surveys defined for your account.

  • GET Lookup Daily Survey Scores For Product /v1/surveys/:surveyId/scores/days/:scoreType

    Lookup Daily Survey Scores For Product

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    :scoreType	rating customscore nps	string	The score type
    pid		date	The product id for which to pull the survey data
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • GET GSS Overall Score for Product and Group /v1/surveys/:surveyId/score/:scoreType

    Lookup GSS Overall Score for Product and Group

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    :scoreType	rating customscore nps	string	The score type
    pid		integer	The product id for which to pull the survey data
    gid		integer	The group id for which to pull the survey data
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • GET GSS NPS Compset for Product /v1/surveys/:surveyId/npsCompetition

    Lookup GSS NPS Compset for Product

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    pid		integer	The product id for which to pull the survey data
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • GET GSS NPS Compset for Group /v1/surveys/:surveyId/npsGroupCompetition

    Lookup GSS NPS Compset for Group

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    gid		integer	The group id for which to pull the survey data
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • GET Lookup Daily Survey Scores For Group /v1/surveys/:surveyId/scores/days/:scoreType

    Lookup Daily Survey Scores For Product

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    :scoreType	rating customscore nps	string	The score type
    gid		integer	The product group id
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • GET Lookup responses by survey id (V3) /v3/surveys/:surveyId/responses

    Look up survey responses for the survey id. Responses are in ascending time order.

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    pid		integer	The product id you want to filter results by
    externalId		string	The external product id (like PMS ID) you want to filter results by
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01
    offset		integer	Index of the first response to be returned. Indexes start at 0. If not provided, the default is 0
    limit		integer	Number of responses to return. Must be greater than 0 and lesser than 100. If not provided, the default is 100
    flagged	NOT_FLAGGED ONLY_FLAGGED ALL	string	If you want to include flagged and/or non-flagged responses. Possible values: NOT_FLAGGED (default), ONLY_FLAGGED, ALL
    onlyPublished	True False	boolean	If you want to show only published responses
    dateField	RESPONSE_DATE FLAGGED_DATE	string	Date used to filter and sort responses (note that responses without the field won't be shown). Possible values: RESPONSE_DATE (default), FLAGGED_DATE (only allowed if flagged = ONLY_FLAGGED)

  • POST Search responses by attribute /v1/surveys/_searchByAttribute

    Search a response by attribute

    Parameter	Value	Type	Description
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01
    Content-Type	application/json	string	json

    Request Body

    {}

    {}
  • GET Brand impact by survey id /v1/surveys/:surveyId/brandImpact

    Computes the brand impact for the survey id.

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    gid		integer	The group id for which to compute the brand impact
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • GET GSS Survey Questions /v1/surveys/:surveyId/questions

    Lookup GSS Survey Questions

    Parameter	Value	Type	Description
    :surveyId		string	Survey id

  • POST Import guests (PMS) /v1/pms/guests/:surveyId

    Add a list of guests to ReviewPro survey system (documentation)

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    Content-Type	application/json	string	json

    Request Body

    []

    []
  • GET GSS Guest stats /v1/surveys/:surveyId/guests

    Statistics about guests

    Parameter	Value	Type	Description
    :surveyId		string	Survey id
    pids		string	The product id for which to pull guests data
    gid		integer	The group id for which to pull guests data
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

• Delivery

  • List Methods
  • Expand Methods

  • GET Delivery /v1/lodging/delivery/index

    Delivery stats (documentation)

    Parameter	Value	Type	Description
    pids		string	The pids for which to extract stats
    surveyId		string	The survey id
    fd		date	The from date-time in the format yyyy-MM-dd e.g. 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g. 2024-01-01

• Guest-stays

  • List Methods
  • Expand Methods

  • GET Lookup available staylist /v1/stayList

    Look up stayLists defined for your account.

  • GET Lookup stayList fields mapping /v1/stayList/:stayListId/mapping/pms_api

    Look up the mapping definition.

    Parameter	Value	Type	Description
    :stayListId		string	StayList id

  • POST Import reservations (PMS) /v1/stayList/:stayListId/mapping/pms_api/ingest

    Add a list of reservations to a ReviewPro staylist (documentation)

    Parameter	Value	Type	Description
    :stayListId		string	stayList id
    Content-Type	application/json	string	json

    Request Body

    []

    []
  • POST search stay by unique Attributes /v1/stayList/:stayListId/stay/_searchByUniqueAttributes

    Search a stay by unique attributes

    Parameter	Value	Type	Description
    :stayListId		string	stayList id
    Content-Type	application/json	string	json

    Request Body

    {}

    {}
  • POST search one stay /v1/stayList/:stayListId/stay/_searchOne

    Search one stay

    Parameter	Value	Type	Description
    :stayListId		string	stayList id
    Content-Type	application/json	string	json

    Request Body

    {}

    {}

• Guest Profiles

  • List Methods
  • Expand Methods

  • GET Get a profile by id /v1/profile/details/:id

    Get a profile by id

    Parameter	Value	Type	Description
    :id		string	Profile id

  • GET Search Profiles /v1/profile/_search

    Search Profiles

    Parameter	Value	Type	Description
    fd		date	The from date-time in the format yyyy-MM-dd 2024-01-01
    td		date	The to date-time in the format yyyy-mm-dd e.g 2024-01-01

  • POST Search profiles by attribute /v1/profile/_searchByAttribute

    Search a profile by attribute

    Parameter	Value	Type	Description
    Content-Type	application/json	string	json

    Request Body

    {}

    {}