📘

Exposition Metrics Statistics API

Introduction

This is part of set of tools, located at rcdata.org, that allows users to navigate the content of RC in alternative ways. The API documented below allows sorting the expositions of the RC by certain metrics: number of tools, type of editor, number of pages etc…

The public API provides endpoints for retrieving and sorting structured data from a JSON dataset, supporting filters based on tool types, metrics, and page types.

The source code may be found under
https://github.com/SocietyForArtisticResearch/rc-linked-data

The current live version of this can be found on https://map.rcdata.org/api/ followed by an endpoint and parameters as described below.

📊 Endpoints

GET /api/highest-total-tools

Returns the top entries sorted by the total number of tools.

Query Parameters:

• n (optional): Number of results to return (default: 50)
• page_type (optional): Filter by default page type

Example:

https://map.rcdata.org/api/highest-total-tools?n=100

GET /api/highest-total-pages

Returns the top entries sorted by the total number of pages.

Query Parameters: - n (optional): Number of results to return (default: 50) - page_type (optional): Filter by default page type.

Page types may be

• weave-graphical
• weave-text
• weave-iframe
• weave-block

Example:

https://map.rcdata.org/api//highest-total-pages?page_type=weave-graphical

GET /api/sort-by-tool

Returns the top entries sorted by a specific tool type count.

Query Parameters:

• tool (required): Tool type (e.g., tool-video, tool-text, etc.)
• n (optional): Number of results to return (default: 50)
• page_type (optional): Filter by default page type

Valid Tool Types:

• tool-video
• tool-audio
• tool-picture
• tool-slideshow
• tool-pdf
• tool-text (includes tool-simpletext)
• tool-simpletext

Example:

https://map.rcdata.org/api/sort-by-tool?tool=tool-text&n=20&page_type=weave-graphical

GET /api/sort-by-metric

Returns the top graphical entries sorted by a specific metric.

Query Parameters: - metric (required): Metric key to sort by - n (optional): Number of results to return (default: 50)

Valid Metrics:

• alignment_score
• horizontal_vertical_ratio
• overall_regular_score
• overlap_percentage
• size_uniformity_score
• spacing_score
• white_space_percentage

Example:

https://map.rcdata.org/api/sort-by-metric?metric=overall_regular_score

GET /api/filter-by-page-type

Filters entries by their default page type.

Query Parameters:

• page_type (required): filter by which editor has been used to generate the exposition:

  • weave-graphical
  • weave-text
  • weave-iframe
  • weave-block

Example:

https://map.rcdata.org/api/filter-by-page-type?page_type=weave-graphical

GET /api/exposition/[exposition-id]

Exposition id is the first number in the url of any page (or you can find it on META). Returns the statistics of a single exposition.

Example:

For example, in this exposition:
“https://www.researchcatalogue.net/view/29778/29779” the id is 29778.

It’s statistics can be retrieved as follows:
https://map.rcdata.org/api/exposition/29778

Parsed exposition content as json:

GET /rcjson/expo/[exposition-id]

This will return the exposition content in a json format. It provides the following metadata.

Note: this currently is not located under /api but directly under /rcjson

https://map.rcdata.org/rcjson/expo/2348302

GET /api/sort-by-link

This sorts expositions by the number of hyperlinks found inside of it. Hyperlinks are categorized depending wether they are local to the exposition, the RC or completely external.

Query parameters:

• link_type
  • same_exposition
  • other_expositions
  • reference
  • broken (would report broken links, but currently turned off as this took a lot of resources)

example:
https://map.rcdata.org/api/sort-by-link?link_type=same_exposition