Skip to main content
The GraphQL API is Darpan’s external, read-only API. An API key belongs to one tenant, and every query reads only that tenant’s data.
The audit queries (auditReport, auditFinding) and API key rotation arrive on an instance with its next Darpan release. Until then, GET /rest/s1/graphql/sdl on your instance shows exactly what it serves.

​
What you can read

  • auditReport: one audit’s report for one morning. Whether the checks can be trusted, what is open, and every statement by category with its checks and findings.
  • auditFinding: one finding. Its records in each system, evidence, how to fix it, how Darpan confirms the fix, and its history.
  • reconciliationResults and reconciliationResult: reconciliation run results.
The audit queries return the same documents as Darpan’s JSON (darpan.audit.report/v1, darpan.audit.finding/v1), with one difference: GraphQL has no maps with dynamic keys, so a keyed object in the JSON is a list here, and each element carries its key (categories: [{ id: "orders", … }]).

​
Make a request

Every response has the same envelope: data, errors and extensions.cost. See Errors and Cost and throttling.

​
Fixing what a finding reports

The API has no mutations. Fix a record in the system it lives in (NetSuite, the OMS, Shopify) with your own tools. Darpan’s next scheduled check looks at the record again and closes the finding when the check no longer reports it.

​
JSON-RPC

/rpc/json is the API of Darpan’s own app. Integrations should use GraphQL. See API overview.