Polaris-react: Accessing ShopifyQL?

[bakura10]

Issue summary

Hi,

Our next app will make use of Shopify QL. However I realize that there is no way in Polaris to access the Shopify QL object (ShopifyApp.ShopifyAnalytics).

Could you please add a note in the documentation on how the app can fetch analytics?

Thanks!

[ry5n]

(EDIT: my original answer was a bit off the mark. I’ve removed it to avoid confusion for future readers.)

[bakura10]

Hi !

I'd love to do that but... what are the endpoints? The doc explicitly says that we need to use Embedded App SDK.

[ry5n]

You’re right, there are no endpoints listed. I’m going to dig into this a bit more.

[jmojico]

Any new information @bakura10 @ry5n? I was looking for the same

[bakura10]

Nope, I'm still waiting for this one :(.

[ry5n]

Sorry for the delay on this.

With the EmbeddedApp component, we expose some of the underlying EASDK functionality via React’s context as described here. The methods provided are showFlashNotice(), pushState(), redirect(), startLoading() and stopLoading().

It turns out the original EASDK offers an Analytics API. To make ShopifyQL queries, you’d use that API rather than making HTTP requests to endpoints.

It doesn’t look like an equivalent is current exposed by the EmbeddedApp component. I still need to confirm that. I’ll also let you know if there’s a workaround and what plans exist to make it available in Polaris.

[jmojico]

I will share news as soon as I got some piece of working code....thanks @ry5n !

[ry5n]

I can confirm that currently using the React components there isn’t a direct way to access the regular EASDK (and make ShopifyQL calls) from the embedded React components. I’ve logged this internally and we’re working on addressing these limitations.

[ry5n]

Unfortunately we haven’t been able to put this at the top of our priority list, but we treat all feature requests as part of our backlog.

I’ll close this issue for now, but we encourage everyone who wants this feature to add a 👍 to the original issue report. We’ll take your collective interest into account when we look at what to work on next.

💜