Figshare usage statistics API

Use the Figshare usage statistics API to retrieve published views, downloads, citations or other documented usage totals. Specify an item, collection or project and choose the counter and time granularity, optionally adding geography to inspect views, downloads, shares or citations over time. Compare research-output attention over time, inspect geographic usage, or distinguish view, download, share and citation measures. Each counter keeps its own meaning; attention and download totals do not by themselves measure the quality of research. The detail page provides request and response examples, supported parameters, and usage pricing.

Selected price
$0.002 / billing creditPublished pricing
Sellers / implementations
1 / 1
Requests · 30d
—Loading...
Success rate · 30d
—Loading...

Run sends a real API request. Charges follow the published API contract.

Request parameters
Item, collection or project id.
Optional parameters (11)
What the id is.
Counter for the timeline and country totals.
Timeline step (`total` skips the timeline).
Timeline start (YYYY-MM-DD).
Timeline end (YYYY-MM-DD).
true adds totals by country and city.
0 leaves out the bulky `raw` source blocks (often 10-30x smaller).
Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included.
1 skips the 24-hour cache and fetches live.
JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed.
Native CSV/NDJSON record selector; it has no effect on this JSON-only product.

Sample response

{
  "by_country": null,
  "cached": false,
  "counter": "views",
  "credits_used": 1,
  "end_date": null,
  "granularity": "month",
  "id": 7504448,
  "kind": "article",
  "start_date": null,
  "timeline": [
    {
      "count": 2299,
      "period": "2024-11"
    },
    {
      "count": 2502,
      "period": "2024-12"
    },
    "… 23 more"
  ],
  "totals": {
    "cites": 491,
    "downloads": 133823,
    "shares": 2,
    "views": 201053
  }
}

Response result

Response structure

Inferred from examples
  • by_countrynull
  • cachedboolean
  • counterstring
  • credits_usedinteger
  • end_datenull
  • granularitystring
  • idinteger
  • kindstring
  • start_datenull
  • timeline(object | string)[]
    • countinteger
    • periodstring
  • totalsobject
    • citesinteger
    • downloadsinteger
    • sharesinteger
    • viewsinteger

Common questions

Do I need a separate key for every provider?

Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.

Are these providers interchangeable?

No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.

How is this API billed?

API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.

Where do the price and contract come from?

The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.

How do OpenAny Balance and x402 differ?

OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.

Does Playground send a paid request?

Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.

Use Figshare usage statistics API with your agent

Inspect endpoint contracts and confirm availability and pricing before a paid call.