Save to a collection (free)

Save a statistic page to one of the user's collections when they ask to keep, bookmark or save it. Without collection it goes to the default collection, "Saved". Saving the same page again keeps one item and updates its note. What to save: an indicator and a place (a value), an indicator and a ranking scope (a ranking, scope as in the ranking URL: "us-states", "eu-countries", "countries", "texas-counties"), an indicator alone, a place alone, a topic or a publisher. kind is inferred when left out. Examples: {"indicator": "unemployment_rate", "place": "Texas"}. {"indicator": "gdp_per_capita_usd", "scope": "countries", "note": "For the board deck"}. {"kind": "topic", "topic": "labour", "collection": "col_3f9a..."}. Returns {collection: {id, name, visibility}, item: {id, kind, note?}, created, dashboard_url}. A collection holds up to 100 items. Free on every plan.

post/api/v1/collections

Request

  • Base URL: https://invokely.ai
  • URL: https://invokely.ai/api/v1/collections
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key
    • none

Request body

kind'value' | 'ranking' | 'indicator' | 'place' | 'topic' | 'publisher'

Optional. value, ranking, indicator, place, topic or publisher.

indicatorstring

Indicator id, for example "unemployment_rate".

placestring

Place name or id, for example "Texas" or "es-mun-08121".

scopestring

Ranking scope, for example "us-states".

topicstring

Topic id or slug, for example "labour" or "labor-market".

publisherstring

Publisher id or slug, for example "bls" or "ine".

collectionstring

Optional collection id from list_collections. Default: the user's "Saved" collection.

notestring

Optional note shown with the item.

Response

The item was already saved: {collection, item, created: false, dashboard_url}.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.