Surveys for Jira Service Management
Surveys for Jira Service Management
Breadcrumbs

Developer guide

End-of-Life Notice: Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date.

You can retrieve your survey responses via API or export from CES, CSAT and NPS reports via the Export All Scales feature.


Here's how to access the results of surveys answered by customers.

Prerequisites

Authentication

The Surveys for JSM REST API uses the same authentication as the Jira API authentication. For more information, check out Atlassian Developers documentation.

Accessing the endpoint

  1. Enable the API in the Configure tab of your survey settings, for more information read, Set up in-app automation triggers, goal evaluators, and custom fields.

  2. Add the ‘x-api-key’ to your header with the generated API key.

    SURVJSM-devapi-101023.png

  3. Access endpoint via curl H "x-api-key:<insert_API_Key_here>" <insert_endpoint_here> or via API Platform tools such as Postman, WSO2, and others.

GET Method

Retrieving Surveys for JSM results

Surveys for JSM REST API return the survey results when requested with the endpoint parameters below.

https://surveys-jsm.servicerocket.io/surveys?projectKey=my-project-key&responded=true

This example shows the results returned by the API call. In this scenario, there is one block of data as the total number of surveys in that month was one.

{
    "issue_surveys": [{
        "ces_response": 10,
        "comment_response": "Cool",
        "created": "2022-04-04T06:09:58",
        "issue_assignee": null,
        "issue_assignee_id": null,
        "issue_creation_date": 1649051994467,
        "issue_id": 10010,
        "issue_key": "LEV-11",
        "issue_reporter": "Team Lead Jane",
        "modified": "2022-04-04T06:14:26",
        "nps_response": 10,
        "project_key": "LEV",
        "response_date": "2022-04-04T06:13:57",
        "reviewer": "Mark Roberts",
        "reviewer_notes": "Approved",
        "scale_response": 9,
        "survey_id": "bb86cb87-332d-4f62-97ee-0896eb74792b-LEV"
    }],
    "total_surveys": 1,
    "total_surveys_responded": 1
}

info By default, the endpoint parameter returns only one month’s worth of results. Use the “from” and “to” parameter to control the range of the results. For example:

https://survey-jsm.servicerocket.io/surveys?projectKey=my-project-key&responded=false&from=2023-02-02&to=2023-04-29

Endpoint Parameters

key

required

content type

value

projectKey

yes

string

The project that is associated with the surveys.

from

no

string

The starting date range of the surveys.

Default: If no value is passed, there will be a 30-day cut-off point for the endpoint.

Both from and to values must be used together to specify a date range; otherwise, the operation will not work.

to

no

string

The ending date range of the surveys.

Default: If no value is passed, there will be a 30-day cut-off point for the endpoint.

Both from and to values must be used together to specify a date range; otherwise, the operation will not work.

assignee_id

no

string

Filter the results by the assignee_id.

Default: If no value is passed, the results won't be filtered by the assignee.

responded

no

boolean

This parameter specifies whether the data should be searched based on the response date (responded = true) or the creation date (responded = false or absent)

Default: false or absent

Response Code

Code

Definition

200

Returned if the request is successful.

400

Access is not enabled or the API key is invalid