How your collection divides

GET/collection/facets

Signed in

Counts of your copies by publisher, place, tag, grader and decade: the values GET /collection/items filters by. On every plan; the valued breakdowns are in GET /insights/portfolio.

SDK method: collector.getCollectionFacets()
Key scopes: collection:read
Headers: If-None-MatchX-Request-Id

Responses

200OKThe counts.

CollectionFacets

How your copies divide: by publisher, place, tag, grader and decade.

publishersarray of objectrequired
ShowHide the fields of publishers
- idstring (uuid)required
- namestringrequired
- countintegerrequired
locationsarray of objectrequired
ShowHide the fields of locations
- namestringrequired
- countintegerrequired
tagsarray of objectrequired
ShowHide the fields of tags
- namestringrequired
- countintegerrequired
gradersarray of objectrequired
ShowHide the fields of graders
- nameenumrequired
  One ofcgccbcspsapgxegshga
  and 1 more
  other
- countintegerrequired
decadesarray of objectrequired
ShowHide the fields of decades
- decadeintegerrequired
- countintegerrequired

304Not ModifiedNot modified: your copy (the ETag in If-None-Match) is current.

3Errors401 · 429 · 500

401
unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
429
rate_limited temporarily_blocked
rate_limited: Over the caller’s limit: the per-minute burst or the per-day quota (RateLimit headers; wait Retry-After seconds).
temporarily_blocked: Too many refused requests in a row: blocked for a while (Retry-After says how long).
500
internal
internal: Something went wrong on our side (quote the requestId).

curl 'https://api.collection.id/v1/collection/facets' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

{
  "publishers": [
    {
      "id": "6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90",
      "name": "Marvel",
      "count": 212
    }
  ],
  "locations": [
    {
      "name": "Long box 12",
      "count": 180
    }
  ],
  "tags": [
    {
      "name": "keys",
      "count": 14
    }
  ],
  "graders": [
    {
      "name": "cgc",
      "count": 9
    }
  ],
  "decades": [
    {
      "decade": 1990,
      "count": 120
    }
  ]
}

Responses

200OKThe counts.

CollectionFacets

How your copies divide: by publisher, place, tag, grader and decade.

publishersarray of objectrequired
ShowHide the fields of publishers
- idstring (uuid)required
- namestringrequired
- countintegerrequired
locationsarray of objectrequired
ShowHide the fields of locations
- namestringrequired
- countintegerrequired
tagsarray of objectrequired
ShowHide the fields of tags
- namestringrequired
- countintegerrequired
gradersarray of objectrequired
ShowHide the fields of graders
- nameenumrequired
  One ofcgccbcspsapgxegshga
  and 1 more
  other
- countintegerrequired
decadesarray of objectrequired
ShowHide the fields of decades
- decadeintegerrequired
- countintegerrequired

304Not ModifiedNot modified: your copy (the ETag in If-None-Match) is current.

3Errors401 · 429 · 500

401
unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
429
rate_limited temporarily_blocked
rate_limited: Over the caller’s limit: the per-minute burst or the per-day quota (RateLimit headers; wait Retry-After seconds).
temporarily_blocked: Too many refused requests in a row: blocked for a while (Retry-After says how long).
500
internal
internal: Something went wrong on our side (quote the requestId).