Exporting Data for Reporting

With Nautical you have access to all the underlying data; this can be powerful but also something to ensure you manage if you do regular data pulls and requests.

Useful Queries for Reporting Data

Below are some endpoints that can be used to extract common data, use the schema browser in the GraphQL playground to learn more about endpoints you can use, and also for those listed below how you can request additional information by modifying the request itself.

tip

Discovering endpoints, on the right side of the GraphQL Playground, click on ‘DOCS’ to get a full list of endpoints that exist.

Dashboard Orders Summary

The dashboardOrdersSummary query returns summarized sales data for a given date range.

{
  dashboardOrdersSummary (
 identifier: 1, 
 startDate: "2022-01-01", 
 endDate: "2022-12-31"
 ) {
 ordersToFulfill,
 current {
 net
 }
 }
}

Insights Orders Marketplace Summary

The insightsOrdersMarketplaceSummary query returns summarized sales data for a given date range, also broken out by a period dimension (YEAR, QUARTER, MONTH) to generate segments.

{
  insightsOrdersMarketplaceSummary (
 startDate: "2022-05-01", 
 endDate: "2022-07-31", 
 dimension:"MONTH") {
 summary {
 gross,
 orders
 },
 report {
 dimension,
 gross,
 orders,
 }
 }
}

note

Review the other endpoints that start with insights to see more reporting-specific endpoints.

Orders

The orders query returns details about every order.

{
orders (first: 10) {
 edges {
 node {
 id,
 isPaid,
 lines {
 productName,
 variantName,
 totalPrice {
 net {
 amount,
 currency
 }
 }
 }
 }
 }
 }
}

Show more ↓