Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Current »

The “Journal New Content Lookup” endpoint allows a client to retrieve journals in the Third Iron metadata database which have newly-added content within a specified date range.  The endpoint accepts a start date and an end date as query parameters, and returns an array of journal resource objects which represent the journals within the Third Iron metadata database which have articles first recognized by Third Iron between those dates.  

Contact Third Iron Support to Request your API Key

Email us at support@thirdiron.com to request your API Key.  The Data Service API can only be used by institutions subscribing to the Third Iron Data Service.

How to use

Submit a GET request against this endpoint, filling in the appropriate path segments with the id number of your library and adding to the query string a start date and an end date specified in ISO date format (YYYY-MM-DD).  Your application will receive a response representing the journals in the database which have new content published between those dates.  Responses contain:

  • some metadata for each journal, such as a display name and the journal's ISSN

  • links to API endpoints through which metadata resources related to each journal, such as a list of its issues, may be retrieved

Journal New Content Lookup Request

Supported Methods

GET

Endpoint Location

/public/v1/libraries/:library_id/journals/new-content

Endpoint Parameters


:library_id

Replace the :library_id portion of the endpoint path with the id # of your library. (Mandatory)

start_date

Required query string parameter. Add a query string parameter named start_date to specify the beginning of the date range the endpoint should check for issues.  The value should be expressed in YYYY-MM-DD format.

This value must be earlier or equal to end_date.

For accurate results, this date should be no earlier than August 5, 2022.

end_date

Required query string parameter. Add a query string parameter named end_date to specify the end of the date range the endpoint should check for issues.  The value should be expressed in YYYY-MM-DD format

This value must be later or equal to start_date.

Journal New Content Lookup Response

The Journal New Content Lookup endpoint responds with a blob of JSON data that contains an array of journal resource objects that represent the journals in the Third Iron metadata database which have issues published within the specified date range.

Response Object

Property

Type

Description

data

Array of Object

An array of journal resource objects is returned here which represents the journals in the Third Iron metadata database which have issues published within the specified date range.

Issue Resource

A journal resource object represents a journal in the Third Iron metadata database.

The full list of properties that may appear on a journal resource object are described in detail in the table below:

Property

Type

Description

Optional

id

number

The journal's unique id in the Browzine system

No

type

string

has the value "journals"

No

title

string

The journal's title

No

issn

string

The ISSN for the journal that matches the ISSN passed in on the endpoint

(formatted with no hyphen)

The ISSN for print is used preferentially here unless the journal has only an E-ISSN in which case that is the value returned.

No

browzineEnabled

boolean

True when the title is visible within Browzine at the specified library

No

coverImageUrl

string

A url to a small image that can be used to visually depict the journal

No

sjrValue

number

The Scimago Journal Rank (SJR) - see all their ranking at their website

No

browzineWebLink

URL

On titles that are browzine enabled, this property will be present and will link to the journal's current issue within browzine.com

Yes

externalLink

URL

On titles that are not browzine enabled, this property may be present. When it is, it is a link to the journal within the library's A-Z system

Yes

publishingType

string

There are two different values:

  • traditional - the journal typically publishes a new issue and its articles within a few days of each other

  • continuous - this means the journal has new articles continuously added to issues over time. The articles and their issue do not typically all come out close together in time, but the date the issue is first announced by the publisher, and when the articles inside that issue are first announced, may be first shown to the world weeks apart, or even months

Note that publishingType is unrelated to the concept of pre-print, Articles-in-Press articles.

Yes

Examples

Example Request, retrieving journals with issues published between 10/25/19 & 11/1/19

GET https://public-api.thirdiron.com/public/v1/libraries/222/journals/new-content?start_date=2022-08-28&end_date=2022-08-29&access_token=abc123-abc123

Example Response

{
    "data": [
        {
            "id": 6,
            "type": "journals",
            "title": "BMC Ophthalmology",
            "issn": "14712415",
            "sjrValue": 0.877,
            "coverImageUrl": "https://s3.amazonaws.com/thirdiron-assets/images/covers/1471-2415.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/222/journals/6?utm_source=api_123",
            "publishingType": "continuous",
            "relationships": {
                "issues": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/6/issues"
                    }
                },
                "current-issue": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/6/issues/current"
                    }
                }
            }
        },
        {
            "id": 307,
            "type": "journals",
            "title": "IEEE Transactions on Electron Devices",
            "issn": "00189383",
            "sjrValue": 0.828,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/0018-9383.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/222/journals/307?utm_source=api_123",
            "publishingType": "traditional",
            "relationships": {
                "issues": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/307/issues"
                    }
                },
                "current-issue": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/307/issues/current"
                    }
                }
            }
        }
    ]
}

Additional Notes

  • Articles that are considered “in press”, aka pre-print or Publish Ahead of Print, are not considered new content on this endpoint.

  • When the Third Iron Data Service API detects an article that was previously “in press” has been moved to a formal issue by its publisher, that date is when the article is included in the New Content Lookup.

    • Example: an article was first set as a Publish Ahead of Print article on August 15, 2022. Weeks later, on September 4, 2022, the article was moved to Volume 24 Issue 10 of the journal. When using the Third Iron Journal New Content Lookup, that article will appear when you use a date range that includes September 4, 2022.

  • Different journals have different approaches to publishing the existence of new articles, so the concept of “new content” can manifest in different ways across different journals.

    • Although some journals make a new issue available with all of its articles on the same day or within roughly a week, other journals add articles to an issue over multiple weeks, or even months.

    • When a journal adds articles to an issue over multiple weeks or months, the issue date for new content may be significantly different from the articles within the issue. So an issue may have a date of December 2022, but its articles might have been added in September, October, November, and December of that year.

  • An older endpoint that is less helpful is still active. See documentation available for it here.

  • No labels