ComparisonReport

Aggregate reporting API endpoint

APIDescription
POST Reporting/ComparisonReport/Post

Returns a new comparison report.

Measures

APIDescription
GET Measures/{projectDefinedId}?languageName={languageName}&language={language}

Default Measure with Benchmarks for the project and user.

POST Measures/{projectDefinedId}?languageName={languageName}&language={language}

Default Measure with Benchmarks for the project and user.

GET Measures/{projectDefinedId}/All?languageName={languageName}&language={language}&pageNumber={pageNumber}&numberPerPage={numberPerPage}

All Measures with Benchmarks for the project and user.

POST Measures/{projectDefinedId}/All?languageName={languageName}&language={language}&pageNumber={pageNumber}&numberPerPage={numberPerPage}

All Measures with Benchmarks for the project and user.

POST Measures/{projectDefinedId}/Units?languageName={languageName}&language={language}

Default Measure with Benchmarks for the project, user and units.

GET Measures/{projectDefinedId}/Units?questionId={questionId}&projectLevelId={projectLevelId}&language={language}

Default Measure with Benchmarks for the project, user and units.

GET Measures/{projectDefinedId}/AFF/{skey}?languageName={languageName}&language={language}

Default Measure with Benchmarks for the project, user and units.

GET Measures/{projectDefinedId}/CutableAFF/{skey}?languageName={languageName}&language={language}

Default Measure with Benchmarks for the project, user and units.

POST Measures/CompareBy

Gets the CompareByMeasureResponse for the CompareByRequest

PeriodEnd

These are the APIs for getting your pre-generated period end reports.

APIDescription
GET Reporting/PeriodEnd/ReportTypes/{projectDefinedId}?language={language}

Gets all report types available

GET Reporting/PeriodEnd/Periods/{projectDefinedId}?periodEndReportTypeId={periodEndReportTypeId}&language={language}

Gets all periods available filtered by a report type

GET Reporting/PeriodEnd/HierarchyLevels/{projectDefinedId}?periodEndReportTypeId={periodEndReportTypeId}&periodId={periodId}&language={language}

Returns hierarchy levels that have available Period End information.

GET Reporting/PeriodEnd/Languages/{projectDefinedId}?periodEndReportTypeId={periodEndReportTypeId}&periodId={periodId}&hierarchyLevelSortId={hierarchyLevelSortId}&language={language}

Returns languages that have available Period End information.

GET Reporting/PeriodEnd/HierarchyUnits/{projectDefinedId}?periodEndReportTypeId={periodEndReportTypeId}&periodId={periodId}&hierarchyLevelSortId={hierarchyLevelSortId}&language={language}

Returns Hierarchy units that have available Period End information.

GET Reporting/PeriodEnd/Files/{projectDefinedId}?periodEndReportTypeId={periodEndReportTypeId}&periodId={periodId}&hierarchyLevelSortId={hierarchyLevelSortId}&language={language}&skey={skey}

Returns a file matching the period end criteria.

Comments

Comments are the answers people leave to open ended questions in surveys.

APIDescription
GET Reporting/Comments/Recent/{projectDefinedId}?languageName={languageName}&numberOfComments={numberOfComments}&page={page}

gets most recent comments for a project and user

GET Reporting/Comments/Recent/Search/{projectDefinedId}?skeysList[0]={skeysList[0]}&skeysList[1]={skeysList[1]}&unitDisplaySearchTerm={unitDisplaySearchTerm}&searchText={searchText}&numberOfComments={numberOfComments}&page={page}

Get most recent comments by unit skey list, unitDisplaySearchTerm, or search text. IMPORTANT: In addition to projectDefinedId, one and only one of the following three parameters must be provided. (skeysList, unitDisplaySearchTerm,searchText)

GET Reporting/Comments/{projectDefinedId}?language={language}&latestDateTime={latestDateTime}&pageNumber={pageNumber}&numberPerPage={numberPerPage}&searchText={searchText}

Get the Comments available since the Latest DateTime that is passed in. This should use the datetime returned from GetCommentsCount call in order to maintain consistent values when getting the paged results.

POST Reporting/Comments/{projectDefinedId}?language={language}&latestDateTime={latestDateTime}&pageNumber={pageNumber}&numberPerPage={numberPerPage}&searchText={searchText}

Get the Comments available since the Latest DateTime that is passed in. This should use the datetime returned from GetCommentsCount call in order to maintain consistent values when getting the paged results.

GET Reporting/Comments/{projectDefinedId}/QuickAges?language={language}

Gets the Comment Quick Ages for filtering

GET Reporting/Comments/{projectDefinedId}/OpenEnds?language={language}

Gets a list of open end comments

GET Reporting/Comments/{projectDefinedId}/Count?language={language}

Get the total count of Most Recent Comments.

GET Reporting/Comments/Files/{projectDefinedId}/{commentId}?format={format}

Streams an audio comment file in either mp3 or wav format.

Reporting

APIDescription
GET Reporting/WebText/{languageName}/{projectDefinedId}?userName={userName}&webTextNames[0]={webTextNames[0]}&webTextNames[1]={webTextNames[1]}

get localized text for a project and user

GET Reporting/WebText/{languageName}?webTextNames[0]={webTextNames[0]}&webTextNames[1]={webTextNames[1]}

get localized text

GET Reporting/MobileAppSettings/{projectDefinedId}

gets the settings for the mobile reporting app

GET Reporting/MobileAppVersionInfo

gets the app version info for the mobile app

GET Reporting/Quickscores/{projectDefinedId}?language={language}

Gets the quickscores. Quickscores are like small pre-configured reports. Each one is a single value for a single metric over a period of time.

GET Reporting/Alerts/ResponseTypes/{projectDefinedId}?language={language}

Pulls back all the Alert Response Types for a given project and user in the language specificed.

GET Reporting/AlertQuickAges/{projectDefinedId}?language={language}

Gets the Alert Ages

GET Reporting/Alerts/{projectDefinedId}?language={language}&isResolved={isResolved}&numberOfItems={numberOfItems}&page={page}

Pulls back all the Alert headers for a given project and user in the language specificed.

GET Reporting/Alerts/{projectDefinedId}/Summary?language={language}&isResolved={isResolved}&latestDateTime={latestDateTime}&numberOfItems={numberOfItems}&page={page}

Pulls back all the Alert headers for a given project and user in the language specificed.

POST Reporting/Alerts/{projectDefinedId}/Summary?language={language}&isResolved={isResolved}&latestDateTime={latestDateTime}&numberOfItems={numberOfItems}&page={page}

Pulls back all the Alert headers for a given project and user in the language specificed.

PUT Reporting/Alerts/{projectDefinedId}

Updates an alert, can set the alert to be marked as resolved, or add a comment to the alert Comment can not be greater that 1000 characters or less than 10 characters

GET Reporting/Alerts/{projectDefinedId}/{alertId}?language={language}&includeAudioEncodedData={includeAudioEncodedData}

Pulls back all the details for a particular alert given the project and user in the language specified.

GET Reporting/Alerts/Details/{projectDefinedId}?alertIds[0]={alertIds[0]}&alertIds[1]={alertIds[1]}&language={language}

Given a list of alert ids, this will pull back all the details and comments from an several alerts, Survey responses are not given from this API

GET Reporting/FullWebSiteUrl?projectDefinedId={projectDefinedId}

Gets a url that can be used by the user to direct them to the landing page of the full reporting site

GET Reporting/OSAT/Location/{projectDefinedId}?lat={lat}&lon={lon}&radius={radius}&num={num}

Returns the OSAT of all the stores surrounding a geo location. One of the parameters: Radius or num is required

GET Reporting/Comparison/Location/{projectDefinedId}?lat={lat}&lon={lon}&radius={radius}&num={num}

Returns the comparison measure assigned to the mobile mapping project setting and returns with location information