SP - REST API

Owned by Iryna Ihnatiuk
Sept 06, 2021

Content is in progress

In addition to viewing results in the app UI inside Jira, you can also use REST API to retrieve survey data and work with it further in other systems.

Authentication

We use Jira authentication, that is a user must be logged in Jira to be able to retrieve survey information. In addition to this survey permissions are applied. This means that your user can get the same level of information from both the app UI and via REST.

REST services


RequestTypeDescription

getAnswers


GET

Gets survey answers to survey custom questions for the single project during the specified date range.

Parameters

  • projectKey – required parameter
  • startDate – required parameter
  • endDate – required parameter

Example for app versions before 3.4.X:

https://example.com/rest/surveysData/1.0/getAnswers?projectKey=TEST&showall=true

Starting with version 3.4.X of the app the new service requires two more parameters, here is an curl example:

curl -u admin:admin -X GET -H "Content-Type: application/json" -G "http://example.com/jira/rest/surveysData/1.0/getAnswers?projectKey=TEST&startDate=&endDate="

getAvgReportGET

Gets results of the Average Rating Report for an active survey in a specified project within the specified date range.

Parameters

  • projectKey – required parameter
  • startDate
  • endDate
getByIssueGET

Gets survey rating and user comment for a specified ticket.

One of the following parameters must be specified:

  • IssueKey
  • IssueId
getDateReportGET

Retrieves data from the "Date Report on User Usage" report for the specified project within the specified date range.

Parameters

  • projectKey – required parameter
  • startDate
  • endDate



Request and response examples

getAnswers

http://example.com/jira/rest/surveysData/1.0/getAnswers?projectKey=TEST&startDate=&endDate=

getAvgReport

http://example.com/jira/rest/surveysData/1.0/getAvgReport?pKey=TEST&startDate=&endDate=


getByIssue


http://example.com/jira/rest/surveysData/1.0/rating/getByIssue?issueKey=TEST-1

The response returns two ratings and comments on a ticket that met survey conditions twice and thus - survey response was received twice.

{
  "status": "200",
  "result": [
    {
      "issueKey": "TEST-1",
      "issueId": 999,
      "issueRating": 4,
      "issueViewRating": "4 out of 5",
      "issueComment": "some comment"
    },
    {
      "issueKey": "TEST-1",
      "issueId": 333,
      "issueRating": 5,
      "issueViewRating": "5 out of 5",
      "issueComment": "another comment"
    }
  ]
}


getDateReport

http://example.com/jira/rest/surveysData/1.0/getDateReport?pKey=TEST&startDate=&endDate=