Counts
******
This endpoint provides information about individual research outputs. For example, you can query this endpoint using a DOI and retrieve the relevant Altmetric data. The API is optimized for querying for a single identifier or a strictly defined search. 

Request
=======

.. function:: GET /{version}/{identifier_type}/{id}

  Fetch a research output using the supplied identifier type and identifier

  **Example request**:

  .. code-block:: http

    GET /v1/doi/10.1038/news.2011.490 HTTP/1.1
    Host: api.altmetric.com

  **Query parameters:**

  .. list-table:: 
    :widths: 20 20 30 30
    :header-rows: 1

    * - Parameter
      - Required
      - Accepts
      - Description
    * - ``version``
      - Yes
      - ``v1``
      - See :ref:`Versioning`      
    * - ``identifier type``
      - Yes
      - ``dimensions_publication_id`` ``doi`` ``handle`` ``pmid`` ``arxiv`` ``ads`` ``ssrn`` ``repec`` ``isbn`` ``id`` ``nct_id`` ``urn`` ``uri``
      - A valid identifier type.
    * - ``identifier``
      - Yes
      - A valid identifier of the type specified by ``identifier_type``
      - Identifiers should not be URL-encoded.

  .. include:: shared/status-codes.rst

.. warning::
    Altmetric IDs are transient and unstable over the medium term. For long term application it is recommended that persistent IDs such as DOIs, arXiv IDs or PMIDs are used instead.

Response object
===============
A ``GET`` request to the **Counts Only** endpoint returns a JSON object with the following keys where available.

.. include:: shared/counts-and-citations/counts-and-citations.rst

Cohorts
-------

.. include:: shared/counts-and-citations/cohorts.rst

Context
-------
Contains details of the Altmetric score and, where possible, provides some context. See :ref:`Breakdown` for a breakdown of context.

.. include:: shared/context_for_score.rst

Breakdown
^^^^^^^^^

.. include:: shared/counts-and-citations/breakdown.rst

History
-------

.. include:: shared/history.rst

Publisher subjects
------------------

.. include:: shared/counts-and-citations/publisher-subjects.rst

Readers
-------

.. include:: shared/readers.rst

Images
------

.. include:: shared/images.rst
 
Example response
================

.. literalinclude:: responses/counts.json
  :language: JSON

Try it yourself
===============
Click on any of the URLs below to view example responses for the listed scenarios. 

.. list-table:: 
   :widths: 50 50 
   :header-rows: 1

   * - Scenario
     - URL
   * - Fetch a research output by its Altmetric Id 
     - https://api.altmetric.com/v1/id/241939
   * - Fetch a research output by its Dimensions Publication Id
     - https://api.altmetric.com/v1/dimensions_publication_id/pub.1091500321
   * - Fetch a research output by its Digital Object Identifier
     - https://api.altmetric.com/v1/doi/10.1038/news.2011.490
   * - Fetch a research output by its PubMed Id
     - https://api.altmetric.com/v1/pmid/21148220 
   * - Fetch a research output by its arXiv Id
     - https://api.altmetric.com/v1/arxiv/1108.2455
   * - Fetch a research output by its bibcode Id
     - https://api.altmetric.com/v1/ads/2012apphl.100y3104b
   * - Fetch a research output by its ISBN number
     - https://api.altmetric.com/v1/isbn/978-3-319-25557-6