Zum Inhalt

Journal Search

GET /api/search/journals

Queries the journals collection with selectable columns and count/numeric aggregation. See shared search behavior for filtering precedence, array unwinding, aggregation output, and validation errors.

Parameters

Parameter Type Description
apikey string API key, if required. Alternatively use the X-API-Key header.
json string JSON-encoded MongoDB filter. Overrides filter.
filter object/array MongoDB filter using bracket notation.
search string Trimmed, case-insensitive regular expression on stored title; replaces the supplied filter.
columns[] array Selected fields plus string id. Array paths may unwind records; see shared search behavior.
aggregate string Non-empty stored field path to group by.
aggregate_function string count (default), sum, mean, or median.
aggregate_value string Numeric stored field path, required for sum, mean, and median.
raw flag No effect for this entity; results are not passed through the project renderer.
limit integer Maximum returned rows; subject to the current pagination behavior.
offset integer Number of rows to skip when limit is used. Defaults to 0; negative values become 0.

Example Request

1
GET /api/search/journals?apikey=YOUR_API_KEY

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "status": 200,
  "count": 1,
  "data": [
    {
      "id": "665ef1234567890abcdef1234",
      "journal": "Example Journal",
      "issn": [
        "1234-5678"
      ],
      "publisher": "Example Press"
    }
  ]
}

Default Fields

Field Description
id Journal ID as string.
journal Stored journal title.
issn Stored ISSN value/array.
publisher Stored publisher.

Missing stored or rendered fields may be omitted. count is the number of projected rows before shared pagination; aggregation instead reports the number of groups. full and formatted are not supported.

Searching Journal Titles

search targets title, not the journal's usual journal field. Use a MongoDB filter for journal-name searches:

1
GET /api/search/journals?apikey=YOUR_API_KEY&json=%7B%22journal%22%3A%7B%22%24regex%22%3A%22Example%22%2C%22%24options%22%3A%22i%22%7D%7D

This compact projection does not include the impact and activity-count fields provided by the journal table.