API_documentation_Python/Metrics_API_Python.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Metrics Search Requests\n",
    "This notebook explains how to use the API to retrieve citation data and other metrics for a given bibcode(s). Examples here will be shown using Python with the use of the [requests](http://docs.python-requests.org/en/master/) library, though the same work could be done using the [unofficial Python ADS library](https://ads.readthedocs.io/en/latest/) or curl commands on the command line (see the \"API documentation - UNIX shell\" folder in this same repository).\n",
    "\n",
    "The **base_url** for metrics queries is `https://api.adsabs.harvard.edu/v1/metrics`. The given endpoint in each section should be appended to the end of the base URL to make the full URL to be used in the request. \n",
    "\n",
    "In all examples below, `token` should be replaced with [your own API token](https://ui.adsabs.harvard.edu/user/settings/token). If you haven't worked with our API before, it's recommended that you read the [README](https://github.com/adsabs/adsabs-dev-api/blob/master/README.md) before beginning."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "# import the requests package and set your token in a variable for later use\n",
    "import requests\n",
    "import json # the json package will be used for passing the POST payload - see the section below on sending a request\n",
    "\n",
    "token=\"your-token-here\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Sending a metrics request\n",
    "All metrics requests use the HTTP POST method. POST requests require a payload to be specified using the `data` keyword. For metrics, this payload will be JSON formatted, with the key `bibcodes` and a value set to a comma-separated list of the bibcodes to retrieve metrics for. We use the `json` library here to convert between Python dictionaries and JSON strings. For metrics requests, the payload accepts the following keys:\n",
    "\n",
    "* `bibcodes`: **required**; set the value to a list of the bibcodes to retrieve metrics for\n",
    "* `types`: optional; set the value to a list of the types of metrics to retrieve. If `types` is not set, all metrics will be retrieved. The following values are allowed for the `types` list:\n",
    "\n",
    "  * `basic': publication and usage stats (all papers, and just refereed papers)\n",
    "  * `citations': citation stats\n",
    "  * indicators': indicators, like the h-index, g-index, m-index etc etc\n",
    "  * 'histograms': publication, citation, reads and downloads histograms\n",
    "  * 'timeseries': time series for a set of indicators\n",
    "  \n",
    "* `histograms`: optional; if `histograms` is specified under `types`, this keyword can be set to specify the histograms to return. The following values are allowed (more information is given below):\n",
    "\n",
    "  * `publications`\n",
    "  * `reads`\n",
    "  * `downloads`\n",
    "  * `citations`"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Response from a metrics request\n",
    "The service returns JSON with attributes determined by the contents of the `types` list (no such list means that everything gets returned). It always contains an attribute `skipped bibcodes`, which is a list of bibcodes for which no metrics data could be found. The following JSON attributes are returned by each type:\n",
    "\n",
    "  * 'basic': 'basic stats' and 'basic stats refereed'\n",
    "  * 'citations': 'citation stats' and 'citation stats refereed'\n",
    "  * 'indicators': 'indicators' and 'indicators refereed'\n",
    "  * 'histograms': 'histograms'\n",
    "  * 'timeseries': 'time series'\n",
    "\n",
    "Each of these attributes contains specific data elements. The following sections shows what each type contains (each bullet point is an attribute name, or JSON key).\n",
    "\n",
    "#### 'basic stats' and 'basic stats refereed'\n",
    "  * number of papers\n",
    "  * normalized paper count\n",
    "  * median number of reads\n",
    "  * average number of reads\n",
    "  * total number of reads\n",
    "  * normalized number of reads\n",
    "  * median number of downloads\n",
    "  * average number of downloads\n",
    "  * total number of downloads\n",
    "  * normalized number of downloads\n",
    "  \n",
    "#### 'citation stats' and 'citation stats refereed'\n",
    "  * number of citing papers\n",
    "  * median number of citations\n",
    "  * average number of citations\n",
    "  * total number of citations\n",
    "  * normalized number of citations\n",
    "  * median number of refereed citations\n",
    "  * average number of refereed citations\n",
    "  * total number of refereed citations\n",
    "  * normalized number of refereed citations\n",
    "  * number of self-citations\n",
    "\n",
    "#### 'indicators'\n",
    "  * i10\n",
    "  * i100\n",
    "  * h\n",
    "  * m\n",
    "  * g\n",
    "  * read10\n",
    "  * tori\n",
    "\n",
    "#### 'histograms'\n",
    "For all histograms, the actual histogram values are stored as follows:\n",
    "```\n",
    "    {\n",
    "\t    \"histogram name\": {year: value, year: value, ...}\n",
    "\t}\n",
    "```\n",
    "where values can be either integers or floats, depending on the type of histograms. The histogram name is an attribute of the histogram type. For example, the `publications` type has 4 separate histograms: `all publications`, `refereed publications`, `all publications normalized` and `refereed publications normalized`, which are organized as follows in the JSON output:\n",
    "```\n",
    "    {\n",
    "\t    \"histograms\":  {\n",
    "\t\t\t\"publications\": {\n",
    "\t\t\t\t\"all publications\": {},\n",
    "\t\t\t\t\"refereed publications\": {},\n",
    "\t\t\t\t\"all publications normalized\": {},\n",
    "\t\t\t\t\"refereed publications normalized\": {},\n",
    "\t\t\t\n",
    "\t\t\t}\n",
    "\t\t}\n",
    "\t}\n",
    "```\n",
    "The following lists all histogram types and the names of the actual histograms stored in them:\n",
    "\n",
    "  * 'publications': 'all publications', 'refereed publications', 'all publications normalized', 'refereed publications normalized'\n",
    "  * 'reads': 'all reads', 'refereed reads', 'all reads normalized', 'refereed reads normalized'\n",
    "  * 'downloads': 'all downloads', 'refereed downloads', 'all downloads normalized', 'refereed downloads normalized'\n",
    "  * 'citations': 'refereed to refereed', 'nonrefereed to refereed', 'refereed to nonrefereed', 'nonrefereed to nonrefereed', 'refereed to refereed normalized', 'nonrefereed to refereed normalized', 'refereed to nonrefereed normalized', 'nonrefereed to nonrefereed normalized'\n",
    "\n",
    "Note that 'refereed reads' means: 'number of reads for the refereed publications in the set'.\n",
    "\n",
    "#### 'timeseries'\n",
    "The `timeseries` attribute contains time series data for: `h`, `g`, `i10`, `i100`, `read10` and `tori`. The output is structured as\n",
    "```\n",
    "    {\n",
    "\t\t\"time series\": {\n",
    "\t\t\t\"h\": { values },\n",
    "\t\t\t\"g\": { values },\n",
    "\t\t\t\"i10\": { values },\n",
    "\t\t\t\"i100\": { values },\n",
    "\t\t\t\"read10\": { values },\n",
    "\t\t\t\"tori\": { values },\n",
    "\t\t\n",
    "\t\t}\n",
    "\t}\n",
    "```\n",
    "where the 'values' are organized in the same way as for the histograms: \n",
    "```\n",
    "    {\n",
    "\t    \"indicator name\": {year: value, year: value, ...}\n",
    "\t}\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Examples"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'skipped bibcodes': [],\n",
       " 'basic stats': {'number of papers': 1,\n",
       "  'normalized paper count': 0.058823529411764705,\n",
       "  'total number of reads': 22882,\n",
       "  'average number of reads': 22882.0,\n",
       "  'median number of reads': 22882.0,\n",
       "  'recent number of reads': 110,\n",
       "  'total number of downloads': 9122,\n",
       "  'average number of downloads': 9122.0,\n",
       "  'median number of downloads': 9122.0,\n",
       "  'recent number of downloads': 43},\n",
       " 'basic stats refereed': {'number of papers': 1,\n",
       "  'normalized paper count': 0.058823529411764705,\n",
       "  'total number of reads': 22882,\n",
       "  'average number of reads': 22882.0,\n",
       "  'median number of reads': 22882.0,\n",
       "  'recent number of reads': 110,\n",
       "  'total number of downloads': 9122,\n",
       "  'average number of downloads': 9122.0,\n",
       "  'median number of downloads': 9122.0,\n",
       "  'recent number of downloads': 43},\n",
       " 'citation stats': {'number of citing papers': 9724,\n",
       "  'number of self-citations': 0,\n",
       "  'self-citations': [],\n",
       "  'total number of citations': 9724,\n",
       "  'average number of citations': 9724.0,\n",
       "  'median number of citations': 9724.0,\n",
       "  'normalized number of citations': 572.0,\n",
       "  'total number of refereed citations': 8294,\n",
       "  'average number of refereed citations': 8294.0,\n",
       "  'median number of refereed citations': 8294.0,\n",
       "  'normalized number of refereed citations': 487.88235294117646},\n",
       " 'citation stats refereed': {'number of citing papers': 9724,\n",
       "  'number of self-citations': 0,\n",
       "  'total number of citations': 9724,\n",
       "  'average number of citations': 9724.0,\n",
       "  'median number of citations': 9724.0,\n",
       "  'normalized number of citations': 572.0,\n",
       "  'total number of refereed citations': 8294,\n",
       "  'average number of refereed citations': 8294.0,\n",
       "  'median number of refereed citations': 8294.0,\n",
       "  'normalized number of refereed citations': 487.88235294117646},\n",
       " 'histograms': {'reads': {'all reads': {'1996': 0,\n",
       "    '1997': 0,\n",
       "    '1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 839,\n",
       "    '2004': 1999,\n",
       "    '2005': 1838,\n",
       "    '2006': 1909,\n",
       "    '2007': 1719,\n",
       "    '2008': 1405,\n",
       "    '2009': 1243,\n",
       "    '2010': 1355,\n",
       "    '2011': 1368,\n",
       "    '2012': 1348,\n",
       "    '2013': 929,\n",
       "    '2014': 919,\n",
       "    '2015': 743,\n",
       "    '2016': 797,\n",
       "    '2017': 787,\n",
       "    '2018': 884,\n",
       "    '2019': 929,\n",
       "    '2020': 727,\n",
       "    '2021': 474,\n",
       "    '2022': 560,\n",
       "    '2023': 110},\n",
       "   'all reads normalized': {'1996': 0.0,\n",
       "    '1997': 0.0,\n",
       "    '1998': 0.0,\n",
       "    '1999': 0.0,\n",
       "    '2000': 0.0,\n",
       "    '2001': 0.0,\n",
       "    '2002': 0.0,\n",
       "    '2003': 49.35294117647059,\n",
       "    '2004': 117.58823529411765,\n",
       "    '2005': 108.11764705882354,\n",
       "    '2006': 112.29411764705883,\n",
       "    '2007': 101.11764705882354,\n",
       "    '2008': 82.6470588235294,\n",
       "    '2009': 73.11764705882354,\n",
       "    '2010': 79.70588235294117,\n",
       "    '2011': 80.47058823529412,\n",
       "    '2012': 79.29411764705883,\n",
       "    '2013': 54.64705882352941,\n",
       "    '2014': 54.05882352941177,\n",
       "    '2015': 43.705882352941174,\n",
       "    '2016': 46.88235294117647,\n",
       "    '2017': 46.294117647058826,\n",
       "    '2018': 52.0,\n",
       "    '2019': 54.64705882352941,\n",
       "    '2020': 42.76470588235294,\n",
       "    '2021': 27.88235294117647,\n",
       "    '2022': 32.94117647058823,\n",
       "    '2023': 6.470588235294118},\n",
       "   'refereed reads': {'1996': 0,\n",
       "    '1997': 0,\n",
       "    '1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 839,\n",
       "    '2004': 1999,\n",
       "    '2005': 1838,\n",
       "    '2006': 1909,\n",
       "    '2007': 1719,\n",
       "    '2008': 1405,\n",
       "    '2009': 1243,\n",
       "    '2010': 1355,\n",
       "    '2011': 1368,\n",
       "    '2012': 1348,\n",
       "    '2013': 929,\n",
       "    '2014': 919,\n",
       "    '2015': 743,\n",
       "    '2016': 797,\n",
       "    '2017': 787,\n",
       "    '2018': 884,\n",
       "    '2019': 929,\n",
       "    '2020': 727,\n",
       "    '2021': 474,\n",
       "    '2022': 560,\n",
       "    '2023': 110},\n",
       "   'refereed reads normalized': {'1996': 0.0,\n",
       "    '1997': 0.0,\n",
       "    '1998': 0.0,\n",
       "    '1999': 0.0,\n",
       "    '2000': 0.0,\n",
       "    '2001': 0.0,\n",
       "    '2002': 0.0,\n",
       "    '2003': 49.35294117647059,\n",
       "    '2004': 117.58823529411765,\n",
       "    '2005': 108.11764705882354,\n",
       "    '2006': 112.29411764705883,\n",
       "    '2007': 101.11764705882354,\n",
       "    '2008': 82.6470588235294,\n",
       "    '2009': 73.11764705882354,\n",
       "    '2010': 79.70588235294117,\n",
       "    '2011': 80.47058823529412,\n",
       "    '2012': 79.29411764705883,\n",
       "    '2013': 54.64705882352941,\n",
       "    '2014': 54.05882352941177,\n",
       "    '2015': 43.705882352941174,\n",
       "    '2016': 46.88235294117647,\n",
       "    '2017': 46.294117647058826,\n",
       "    '2018': 52.0,\n",
       "    '2019': 54.64705882352941,\n",
       "    '2020': 42.76470588235294,\n",
       "    '2021': 27.88235294117647,\n",
       "    '2022': 32.94117647058823,\n",
       "    '2023': 6.470588235294118}},\n",
       "  'citations': {'refereed to refereed': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 2,\n",
       "    '2002': 0,\n",
       "    '2003': 383,\n",
       "    '2004': 979,\n",
       "    '2005': 997,\n",
       "    '2006': 998,\n",
       "    '2007': 657,\n",
       "    '2008': 534,\n",
       "    '2009': 458,\n",
       "    '2010': 408,\n",
       "    '2011': 362,\n",
       "    '2012': 341,\n",
       "    '2013': 315,\n",
       "    '2014': 280,\n",
       "    '2015': 250,\n",
       "    '2016': 205,\n",
       "    '2017': 190,\n",
       "    '2018': 178,\n",
       "    '2019': 180,\n",
       "    '2020': 177,\n",
       "    '2021': 191,\n",
       "    '2022': 177,\n",
       "    '2023': 32},\n",
       "   'refereed to nonrefereed': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0},\n",
       "   'nonrefereed to refereed': {'1998': 1,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 2,\n",
       "    '2003': 98,\n",
       "    '2004': 161,\n",
       "    '2005': 269,\n",
       "    '2006': 154,\n",
       "    '2007': 113,\n",
       "    '2008': 76,\n",
       "    '2009': 77,\n",
       "    '2010': 54,\n",
       "    '2011': 36,\n",
       "    '2012': 49,\n",
       "    '2013': 38,\n",
       "    '2014': 32,\n",
       "    '2015': 34,\n",
       "    '2016': 35,\n",
       "    '2017': 28,\n",
       "    '2018': 30,\n",
       "    '2019': 34,\n",
       "    '2020': 28,\n",
       "    '2021': 17,\n",
       "    '2022': 51,\n",
       "    '2023': 13},\n",
       "   'nonrefereed to nonrefereed': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0},\n",
       "   'refereed to refereed normalized': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0.11764705882352941,\n",
       "    '2002': 0,\n",
       "    '2003': 22.52941176470581,\n",
       "    '2004': 57.588235294118995,\n",
       "    '2005': 58.64705882353082,\n",
       "    '2006': 58.70588235294259,\n",
       "    '2007': 38.64705882352968,\n",
       "    '2008': 31.41176470588225,\n",
       "    '2009': 26.941176470588147,\n",
       "    '2010': 23.999999999999922,\n",
       "    '2011': 21.294117647058755,\n",
       "    '2012': 20.0588235294117,\n",
       "    '2013': 18.529411764705824,\n",
       "    '2014': 16.470588235294066,\n",
       "    '2015': 14.705882352941131,\n",
       "    '2016': 12.058823529411729,\n",
       "    '2017': 11.176470588235262,\n",
       "    '2018': 10.470588235294088,\n",
       "    '2019': 10.588235294117617,\n",
       "    '2020': 10.411764705882323,\n",
       "    '2021': 11.235294117647026,\n",
       "    '2022': 10.411764705882323,\n",
       "    '2023': 1.8823529411764708},\n",
       "   'refereed to nonrefereed normalized': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0},\n",
       "   'nonrefereed to refereed normalized': {'1998': 0.058823529411764705,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0.11764705882352941,\n",
       "    '2003': 5.764705882352928,\n",
       "    '2004': 9.470588235294091,\n",
       "    '2005': 15.823529411764657,\n",
       "    '2006': 9.05882352941174,\n",
       "    '2007': 6.647058823529395,\n",
       "    '2008': 4.470588235294109,\n",
       "    '2009': 4.529411764705873,\n",
       "    '2010': 3.17647058823529,\n",
       "    '2011': 2.117647058823529,\n",
       "    '2012': 2.8823529411764675,\n",
       "    '2013': 2.235294117647058,\n",
       "    '2014': 1.8823529411764708,\n",
       "    '2015': 2.0,\n",
       "    '2016': 2.0588235294117645,\n",
       "    '2017': 1.647058823529412,\n",
       "    '2018': 1.7647058823529413,\n",
       "    '2019': 2.0,\n",
       "    '2020': 1.647058823529412,\n",
       "    '2021': 1.0,\n",
       "    '2022': 2.9999999999999964,\n",
       "    '2023': 0.7647058823529412},\n",
       "   'nonrefereed to nonrefereed normalized': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0}}},\n",
       " 'indicators': {'h': 1,\n",
       "  'g': 1,\n",
       "  'i10': 1,\n",
       "  'i100': 1,\n",
       "  'm': 0.047619047619047616,\n",
       "  'read10': 0.0,\n",
       "  'tori': 14.251286835927573,\n",
       "  'riq': 3775},\n",
       " 'indicators refereed': {'h': 1,\n",
       "  'g': 1,\n",
       "  'i10': 1,\n",
       "  'i100': 1,\n",
       "  'm': 0.047619047619047616,\n",
       "  'read10': 0.0,\n",
       "  'tori': 14.251286835927573,\n",
       "  'riq': 3775}}"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# get all metrics for a single bibcode\n",
    "payload = {\"bibcodes\": [\"2003ApJS..148..175S\"]}\n",
    "results = requests.post(\"https://api.adsabs.harvard.edu/v1/metrics\", \\\n",
    "                       headers={'Authorization': 'Bearer ' + token, \n",
    "                                \"Content-type\": \"application/json\"}, \\\n",
    "                       data=json.dumps(payload))\n",
    "results.json()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'skipped bibcodes': [],\n",
       " 'basic stats': {'number of papers': 2,\n",
       "  'normalized paper count': 0.10427807486631016,\n",
       "  'total number of reads': 41887,\n",
       "  'average number of reads': 20943.5,\n",
       "  'median number of reads': 20943.5,\n",
       "  'recent number of reads': 173,\n",
       "  'total number of downloads': 16779,\n",
       "  'average number of downloads': 8389.5,\n",
       "  'median number of downloads': 8389.5,\n",
       "  'recent number of downloads': 66},\n",
       " 'basic stats refereed': {'number of papers': 2,\n",
       "  'normalized paper count': 0.10427807486631016,\n",
       "  'total number of reads': 41887,\n",
       "  'average number of reads': 20943.5,\n",
       "  'median number of reads': 20943.5,\n",
       "  'recent number of reads': 173,\n",
       "  'total number of downloads': 16779,\n",
       "  'average number of downloads': 8389.5,\n",
       "  'median number of downloads': 8389.5,\n",
       "  'recent number of downloads': 66}}"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# get basic metrics for multiple bibcodes\n",
    "payload = {\"bibcodes\": [\"2003ApJS..148..175S\", \"2007ApJS..170..377S\"],\n",
    "          \"types\": [\"basic\"]}\n",
    "results = requests.post(\"https://api.adsabs.harvard.edu/v1/metrics\", \\\n",
    "                       headers={'Authorization': 'Bearer ' + token, \n",
    "                                \"Content-type\": \"application/json\"}, \\\n",
    "                       data=json.dumps(payload))\n",
    "results.json()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'skipped bibcodes': [],\n",
       " 'histograms': {'citations': {'refereed to refereed': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 2,\n",
       "    '2002': 0,\n",
       "    '2003': 383,\n",
       "    '2004': 979,\n",
       "    '2005': 997,\n",
       "    '2006': 1440,\n",
       "    '2007': 1722,\n",
       "    '2008': 1670,\n",
       "    '2009': 1106,\n",
       "    '2010': 924,\n",
       "    '2011': 773,\n",
       "    '2012': 651,\n",
       "    '2013': 591,\n",
       "    '2014': 483,\n",
       "    '2015': 425,\n",
       "    '2016': 341,\n",
       "    '2017': 326,\n",
       "    '2018': 306,\n",
       "    '2019': 310,\n",
       "    '2020': 284,\n",
       "    '2021': 310,\n",
       "    '2022': 282,\n",
       "    '2023': 46},\n",
       "   'refereed to nonrefereed': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0},\n",
       "   'nonrefereed to refereed': {'1998': 1,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 2,\n",
       "    '2003': 98,\n",
       "    '2004': 161,\n",
       "    '2005': 270,\n",
       "    '2006': 275,\n",
       "    '2007': 314,\n",
       "    '2008': 247,\n",
       "    '2009': 202,\n",
       "    '2010': 122,\n",
       "    '2011': 89,\n",
       "    '2012': 86,\n",
       "    '2013': 69,\n",
       "    '2014': 57,\n",
       "    '2015': 57,\n",
       "    '2016': 54,\n",
       "    '2017': 54,\n",
       "    '2018': 46,\n",
       "    '2019': 52,\n",
       "    '2020': 49,\n",
       "    '2021': 30,\n",
       "    '2022': 76,\n",
       "    '2023': 23},\n",
       "   'nonrefereed to nonrefereed': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0},\n",
       "   'refereed to refereed normalized': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0.11764705882352941,\n",
       "    '2002': 0,\n",
       "    '2003': 22.52941176470581,\n",
       "    '2004': 57.588235294118995,\n",
       "    '2005': 58.64705882353082,\n",
       "    '2006': 78.79679144385224,\n",
       "    '2007': 87.05614973262196,\n",
       "    '2008': 83.04812834224735,\n",
       "    '2009': 56.39572192513444,\n",
       "    '2010': 47.45454545454604,\n",
       "    '2011': 39.97593582887747,\n",
       "    '2012': 34.14973262032119,\n",
       "    '2013': 31.074866310160726,\n",
       "    '2014': 25.697860962567056,\n",
       "    '2015': 22.660427807486762,\n",
       "    '2016': 18.240641711229934,\n",
       "    '2017': 17.35828877005343,\n",
       "    '2018': 16.288770053475854,\n",
       "    '2019': 16.49732620320848,\n",
       "    '2020': 15.275401069518635,\n",
       "    '2021': 16.644385026737904,\n",
       "    '2022': 15.184491978609545,\n",
       "    '2023': 2.518716577540107},\n",
       "   'refereed to nonrefereed normalized': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0},\n",
       "   'nonrefereed to refereed normalized': {'1998': 0.058823529411764705,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0.11764705882352941,\n",
       "    '2003': 5.764705882352928,\n",
       "    '2004': 9.470588235294091,\n",
       "    '2005': 15.868983957219202,\n",
       "    '2006': 14.558823529411681,\n",
       "    '2007': 15.78342245989296,\n",
       "    '2008': 12.243315508021368,\n",
       "    '2009': 10.211229946524062,\n",
       "    '2010': 6.2673796791444,\n",
       "    '2011': 4.526737967914441,\n",
       "    '2012': 4.5641711229946536,\n",
       "    '2013': 3.644385026737966,\n",
       "    '2014': 3.0187165775401064,\n",
       "    '2015': 3.0454545454545445,\n",
       "    '2016': 2.9224598930481274,\n",
       "    '2017': 2.828877005347593,\n",
       "    '2018': 2.491978609625668,\n",
       "    '2019': 2.8181818181818175,\n",
       "    '2020': 2.601604278074866,\n",
       "    '2021': 1.5909090909090904,\n",
       "    '2022': 4.136363636363633,\n",
       "    '2023': 1.2192513368983955},\n",
       "   'nonrefereed to nonrefereed normalized': {'1998': 0,\n",
       "    '1999': 0,\n",
       "    '2000': 0,\n",
       "    '2001': 0,\n",
       "    '2002': 0,\n",
       "    '2003': 0,\n",
       "    '2004': 0,\n",
       "    '2005': 0,\n",
       "    '2006': 0,\n",
       "    '2007': 0,\n",
       "    '2008': 0,\n",
       "    '2009': 0,\n",
       "    '2010': 0,\n",
       "    '2011': 0,\n",
       "    '2012': 0,\n",
       "    '2013': 0,\n",
       "    '2014': 0,\n",
       "    '2015': 0,\n",
       "    '2016': 0,\n",
       "    '2017': 0,\n",
       "    '2018': 0,\n",
       "    '2019': 0,\n",
       "    '2020': 0,\n",
       "    '2021': 0,\n",
       "    '2022': 0,\n",
       "    '2023': 0}}}}"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# get data for a single histogram for multiple bibcodes\n",
    "payload = {\"bibcodes\": [\"2003ApJS..148..175S\", \"2007ApJS..170..377S\"],\n",
    "          \"types\": [\"histograms\"],\n",
    "          \"histograms\": [\"citations\"]}\n",
    "results = requests.post(\"https://api.adsabs.harvard.edu/v1/metrics\", \\\n",
    "                       headers={'Authorization': 'Bearer ' + token, \n",
    "                                \"Content-type\": \"application/json\"}, \\\n",
    "                       data=json.dumps(payload))\n",
    "results.json()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.1"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}