Get all Insights linked to a JPD issue over REST API

[Jeny Stoeva]

Hi @Tanguy Crusson , 

Is it still not possible to get the insights for a JPD issue over API?

I cannot get them from a JQL as well. They seem to not be accessible from anywhere. Are there any plans to expose them. 

I am building my own Assistant on top of JPD since Rovo seems to be useless in that regard and it would be great to have the insights.

Thanks!

[Tanguy Crusson · Accepted solution]

Hi @Jeny Stoeva there are examples for how to use the (still experimental) API for insights here: https://github.com/Jira-Product-Discovery-Integrations/polaris-forge-ref-app

[Jeny Stoeva]

@Tanguy Crusson That's great, thank you!

Are there any restrictions related to the plan or everyone can pull the insights?

[Tanguy Crusson]

anyone who has perms to view the insights can pull them

[Sara Jew Lim]

@Jeny Stoeva were you able to use this API to pull insights? A developer on my team tried to use this API but seems to be hitting access restrictions.

@Tanguy Crusson our dev is an admin in our JPD project, but getting the following error when trying to pull insights ApolloError: GraphQL error: (API-3181) api access is not permitted, see also https://community.developer.atlassian.com/t/jira-product-discovery-get-insights-api-is-failing-with-permission-error/87641

[Tanguy Crusson]

@Sara Jew Lim 👋 Are you following the instructions from here: https://github.com/Jira-Product-Discovery-Integrations/polaris-forge-ref-app/tree/master/get-insights-example

We just tried and it seems to work ok on our side

[Sara Jew Lim]

@Tanguy Crusson thank you! let me share with my developer -- will let you know! thanks for the reply!

[Anil D]

@Tanguy Crusson Yes we are following the same steps mentioned in the github repo https://github.com/Jira-Product-Discovery-Integrations/polaris-forge-ref-app/tree/master/get-insights-example and still getting  ApolloError: GraphQL error: (API-3181) api access is not permitted.  This is failing while executing the graphQL query in the example app. 

There is one more post where it says API is not supported for use https://community.developer.atlassian.com/t/getting-error-api-3181-api-access-is-not-permitted-when-trying-to-use-polaris-graphql-endpoints/85379

Is there any specific permissions required for user to fetch the insights ? However am able to see all the insights in JIRA .

[Tanguy Crusson]

OK are you sure you requested the right scopes? From the instructions:

2. Once the app is created go to Permissions tab and click Add on Jira platform REST API option. Then click Configure and enable those scopes: View user profiles, View Jira issue data, Create and manage issues.

[Anil D]

Yes same permissions are enabled.

[Tanguy Crusson]

Okay it looks like you've stumbled on a bug after all! We've managed to reproduce this issue in some environments. We're investigating. Thanks for raising this!

[Anil D]

Thanks for confirming @Tanguy Crusson 

if possible can you please share a sample response for fetching insight’s from a particular Idea?

Basically what we are trying to achieve is , we want to pull all the insights and idea  from a particular project and then build a dashboard based on data exported. Some kind of reporting based on customer or idea. 

[Edouard Kaiser]

@Anil D and everyone else, we have implemented a temporary fix, if you need to unblock access to those APIs please comment below and add your site URL so that we can turn on the fix for your JPD site.

[Anil D]

Thanks for the fix @Edouard Kaiser . Yes, please do turn on the fix.
Once it is done i will test and confirm.

Edited: removed URL since its no more required.

[Deepti Bhogalkar]

@Edouard Kaiser - Hello! Im working with Anil on testing this issue. were you able to turn the fix on for Dialpad?

[Sara Jew Lim]

@Edouard Kaiser Any chance you can enable the fix for us? We're primed to move our PM org over to JPD, but this last piece will unlock a reporting requirement we have, and would love to be able to validate this API will meet our requirements. We're eager to move forward! Thanks :)

[Edouard Kaiser]

Hi everyone, we're facing some delays with the fix, I apologies. I will keep you in the loop as soon as I have better news. Meanwhile I hope the example I shared below can help you move forward with the development.

[Edouard Kaiser]

Hi everyone again, great news, this should be fixed for everyone and you do not need to share your site URL with me, just try again and let us know!

Apologies again for the delay. 

[Anil D]

Thanks for confirming @Tanguy Crusson 

if possible can you please share a sample response for fetching insight’s from a particular Idea?

Basically what we are trying to achieve is , we want to pull all the insights and idea  from a particular project and then build a dashboard based on data exported. Some kind of reporting based on customer or idea. 

[Edouard Kaiser]

Hi @Anil D I'm working on getting you a sample to unblock your work while we're working on fixing the root cause. Thanks for your patience.

[Edouard Kaiser]

Here's a sample for this GraphQL query:

Body

 query getPolarisInsights($project: ID!, $container: ID) {
   polarisInsights(project: $project, container: $container) {
     id
     description
     snippets {
       id
       oauthClientId
       data
       url
       properties
     }
   }
}

Response

{
  "data": {
  "polarisInsights": [
  {
    "id": "ari:cloud:jira:cf091f5b-2147-4791-9fa7-3e3cgtd56f90:polaris-insight/1391566",
    "description": {
    "type": "doc",
    "content": [
    {
      "type": "paragraph",
      "content": [
     {
       "text": "An example insight added with the ",
       "type": "text",
       "marks": [{ "type": "em" }]
     },
     {
       "text": "Jira Cloud for Slack app",
       "type": "text",
       "marks": [
       {
         "type": "link",
         "attrs": {
           "href": "https://marketplace.atlassian.com/apps/1216863/jira-cloud-for-slack-official?hosting=cloud&tab=overview"
         }
       },
       { "type": "em" },
       { "type": "strong" }
       ]
     },
     {
      "text": ".",
      "type": "text",
      "marks": [{ "type": "em" }, { "type": "strong" }]
     }
    ]
  },
  {
    "type": "paragraph",
    "content": [
      {
        "text": "This thread contains data from customer support on this topic.",
        "type": "text"
      }
    ]
  }
  ],
  "version": 1
  },
    "snippets": [
      {
         "id": "ari:cloud:jira:cf0455b-2147-4791-9fa7-3e3c1wer6f90:polaris-snippet/1789436",
         "oauthClientId": "polaris-example-data",
         "data": null,
         "url": "https://marketplace.atlassian.com/apps/1216863/jira-cloud-for-slack-official?hosting=cloud&tab=overview",
         "properties": {}
      },
      {
         "id": "ari:cloud:jira:cf091f5b-2147-4791-9fa7-3e3crty56f90:polaris-snippet/1778937",
         "oauthClientId": "polaris",
         "data": {},
         "url": null,
        "properties": { "impact": { "name": "impact", "value": 3 } }
      }
    ]
  },
  {
     "id": "ari:cloud:jira:cf0sdfg5b-2147-4791-9fa7-3eertbd56f90:polaris-insight/1391237",
     "description": {
       "type": "doc",
       "content": [
         {
            "type": "paragraph",
            "content": [
              {
                 "text": "An example insight ",
                 "type": "text",
                 "marks": [{ "type": "em" }]
              },
              {
                 "text": "added manually:",
                 "type": "text",
                 "marks": [{ "type": "em" }, { "type": "strong" }]
              }
            ]
         },
         {
            "type": "paragraph",
            "content": [
              {
                 "text": "This dashboard in Pendo shows the usage of a similar feature - might influence how we measure impact here.",
                 "type": "text"
              }
            ]
         },
         {    
           "type": "paragraph",
           "content": [
              {
                 "type": "inlineCard",
                 "attrs": { "url": "https://www.pendo.io/" }
              }
            ]
          }
       ],
       "version": 1
  },
   "snippets": []
}
]
}
}