ForeSee Developer Portal

Everything you need to configure and optimize your ForeSee products. Home of developer documentation, implementation guides, and release notes.

Blueprint

URLs for Getting Data

Get a list of CX Surveys

Use the following URL to view a list of all CX Surveys. No data columns are returned.
https://api.foresee.com/v1/bi/cxmeasure/odata.svc/Measures

Get response data for a CX Survey for the past seven days

Use the following URL to view data for a specific CX Survey. If you do not use a date filter, by default, data is returned for the past seven days.
https://api.foresee.com/v1/bi/cxmeasure/odata.svc/Measures(8866805)/Responses

Note: The above URL uses “Measures (8866805)” to indicate the Measure Key or ID of a desired CX Survey.

Data columns returned:
• rawId
• RespondentId
• questionId
• measurementKey
• responseTime
• questionId
• questionName
• questionPhrase
• questionType
• questionLabel
• AnswerLabels
• AnswerDisplayLabels
• AnswerTexts
• AnswerValue
• AnswerFreeTextValues

Get scores data for a CX Survey for the past seven days

Use the following URL to view scores data for a specific CX Survey. If you do not use a date filter, by default, data is returned for the past seven days.
https://api.foresee.com/v1/bi/cxmeasure/odata.svc/Measures(8866805)/RespondentsScores

Data columns returned:
• rawId
• respondentId
• responseTime
• measurementKey
• latentId
• latentName
• latentType
• latentScore

Get response or scores data for a specific date range

To get response or score data for a specific date range, add a date filter at the end the URL:
?$filter=responseTime gt yyyy-mm-dd and responseTime lt yyyy-mm-dd

where, gt= greater than
lt = less than

The “lt” parameter must be used in conjunction with the “gt” parameter; however, you can use the “gt” parameter without using the “lt” parameter.

When you use only the “gt” parameter, data is returned starting from day after the specified date till yesterday.

Examples:
• To get response data from April 1, 2020 to May 3, 2020 for a CX Survey, use the following URL:
https://api.foresee.com/v1/bi/cxmeasure/odata.svc/Measures(8866805)/Responses?$filter=responseTime gt 2020-03-31 and responseTime lt 2020-05-04

• To get response data from April 1, 2020 till yesterday for a CX Survey, use the following URL:
https://api.foresee.com/v1/bi/cxmeasure/odata.svc/Measures(8866805)/Responses?$filter=responseTime gt 2020-03-31

The URLs in the above examples use “Measures (8866805)” to indicate the Measure Key or ID of a desired CX Survey.

Note:
• If no date range is specified, data is returned for the past seven days.
• Each OData query supports up to 1 year of data. For data beyond a year, you need to make multiple queries and merge them.

Updated 5 months ago

URLs for Getting Data


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.