/ieee/papers/metrics

POST /api/ieee/papers/metrics

Price: 1 credit

Get the usage and citation counters IEEE Xplore publishes for one paper: total full-text downloads, downloads broken down by year and month, the number of citing papers and patents IEEE counts, and the Web of Science and Scopus citation counts with the link to each

How to use it

`total_download_count` counts full-text downloads from IEEE Xplore since `counted_since`, not views of the abstract page, and the monthly rows skip a month IEEE recorded nothing for rather than reporting zero. IEEE leaves `paper_citation_count` and `patent_citation_count` at zero on this surface even for papers it counts citations for elsewhere: read `citation_count` on /ieee/papers, or the rows /ieee/papers/citations returns. IEEE Courses carry no metrics at all.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — IEEE Xplore article number, or the address of the document page (examples: "11007439", "EDP590", "https://ieeexplore.ieee.org/document/11007439/"; minLength: 1)

Response

• @type string (default: "IeeePaperMetrics")
• id string required
• doi string nullable
• total_download_count integer nullable
• paper_citation_count integer nullable
• patent_citation_count integer nullable
• wos_citation_count integer nullable
• scopus_citation_count integer nullable
• scopus_url string nullable
• wos_url string nullable
• yearly_downloads array (default: [])
  • @type string (default: "IeeeYearlyDownloads")
  • year integer nullable
  • year_to_date_download_count integer nullable
  • total_download_count integer nullable
  • counted_since string nullable
  • best_month string nullable
  • months array (default: [])
    • @type string (default: "IeeeMonthlyDownloads")
    • month string required
    • download_count integer required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No IEEE Xplore document with this identifier Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.