Gallery Platform API
Reference

Summarize sales

A period's confirmed and completed sales, by sale date: totals per currency, net sales by month, and the top five buyers and artists. The period defaults to this year so far. Use this, not paging the sales list, to answer how sales have gone.

GET
/gallery/sales/summary

A period's confirmed and completed sales, by sale date: totals per currency, net sales by month, and the top five buyers and artists. The period defaults to this year so far. Use this, not paging the sales list, to answer how sales have gone.

Authorization

bearerAuth sales:read, contacts:read, artworks:read, artists:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: sales:read, contacts:read, artworks:read, artists:read

Query Parameters

from?string

First sale date counted (YYYY-MM-DD), inclusive. Defaults to January 1 of the current year.

Match^\d{4}-\d{2}-\d{2}$
to?string

Last sale date counted (YYYY-MM-DD), inclusive. Defaults to today.

Match^\d{4}-\d{2}-\d{2}$

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "from": "string",  "to": "string",  "sales_count": -9007199254740991,  "totals": [    {      "currency": "string",      "sales_count": -9007199254740991,      "gross_cents": -9007199254740991,      "discount_cents": -9007199254740991,      "net_cents": -9007199254740991    }  ],  "by_month": [    {      "month": "string",      "currency": "string",      "sales_count": -9007199254740991,      "net_cents": -9007199254740991    }  ],  "top_buyers": [    {      "contact_id": "string",      "name": "string",      "currency": "string",      "sales_count": -9007199254740991,      "net_cents": -9007199254740991    }  ],  "top_artists": [    {      "artist_id": "string",      "name": "string",      "currency": "string",      "works_count": -9007199254740991,      "sold_cents": -9007199254740991    }  ],  "truncated": true}