Skip to content
API
/
/
Retrieve a rubric

Mabyduck API (0.7.5)

API for managing subjective studies on Mabyduck.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api.mabyduck.com

Datasets

Operations related to datasets.

Operations

Experiments

Operations related to experiments.

Operations

Rubrics

Operations related to rubrics and leaderboards.

Operations

List all rubrics

Request

Returns a list of rubrics belonging to the given project.

Security
ApiKeyAuth
Path
project_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/rubrics/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
leaderboardsArray of objects(Leaderboard)read-onlyrequired
leaderboards[].​idstringrequired
leaderboards[].​namestring<= 100 charactersrequired

A descriptive name for the leaderboard.

leaderboards[].​date_updatedstring(date-time)(Last updated)read-onlyrequired
namestring<= 100 charactersrequired

A descriptive name for the rubric.

descriptionstring

Optional description of the rubric.

date_createdstring(date-time)read-onlyrequired
date_updatedstring(date-time)(Last updated)read-onlyrequired
]
Response
application/json
[
  {
    "id": "string",
    "leaderboards": [ … ],
    "name": "string",
    "description": "string",
    "date_created": "2019-08-24T14:15:22Z",
    "date_updated": "2019-08-24T14:15:22Z"
  }
]

Retrieve a rubric

Request

Returns data of all leaderboards belonging to a rubric.

Security
ApiKeyAuth
Path
project_idstring^[a-zA-Z0-9]+$required
rubric_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/rubrics/{rubric_id}/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
idstringrequired
leaderboardsArray of objects(LeaderboardDetail)read-onlyrequired
leaderboards[].​idstringrequired
leaderboards[].​namestring<= 100 charactersrequired

A descriptive name for the leaderboard.

leaderboards[].​descriptionstring

Optional description of the leaderboard.

leaderboards[].​date_createdstring(date-time)read-onlyrequired
leaderboards[].​date_updatedstring(date-time)(Last updated)read-onlyrequired
leaderboards[].​include_patternsstring(Include conditions)

Comma-separated list of conditions to include. Supports wildcards (*). Leave empty to include all methods.

leaderboards[].​exclude_patternsstring(Exclude conditions)

Comma-separated list of conditions to exclude. Supports wildcards. Applied after include patterns.

leaderboards[].​entriesArray of objectsread-onlyrequired
leaderboards[].​entries[].​property name*anyadditional property
namestring<= 100 charactersrequired

A descriptive name for the rubric.

descriptionstring

Optional description of the rubric.

date_createdstring(date-time)read-onlyrequired
date_updatedstring(date-time)(Last updated)read-onlyrequired
Response
application/json
{
  "id": "string",
  "leaderboards": [
    { … }
  ],
  "name": "string",
  "description": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "date_updated": "2019-08-24T14:15:22Z"
}

List all leaderboards

Request

Lists all leaderboards belonging to the given rubric.

Security
ApiKeyAuth
Path
project_idstring^[a-zA-Z0-9]+$required
rubric_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/rubrics/{rubric_id}/leaderboards/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
namestring<= 100 charactersrequired

A descriptive name for the leaderboard.

descriptionstring

Optional description of the leaderboard.

date_createdstring(date-time)read-onlyrequired
date_updatedstring(date-time)(Last updated)read-onlyrequired
include_patternsstring(Include conditions)

Comma-separated list of conditions to include. Supports wildcards (*). Leave empty to include all methods.

exclude_patternsstring(Exclude conditions)

Comma-separated list of conditions to exclude. Supports wildcards. Applied after include patterns.

entriesArray of objectsread-onlyrequired
entries[].​property name*anyadditional property
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "date_created": "2019-08-24T14:15:22Z",
    "date_updated": "2019-08-24T14:15:22Z",
    "include_patterns": "string",
    "exclude_patterns": "string",
    "entries": [ … ]
  }
]

Retrieve a leaderboard

Request

Returns only the data of a specific leaderboard.

Security
ApiKeyAuth
Path
leaderboard_idstring^[a-zA-Z0-9]+$required
project_idstring^[a-zA-Z0-9]+$required
rubric_idstring^[a-zA-Z0-9]+$required
curl -i -X GET \
  'https://api.mabyduck.com/projects/{project_id}/rubrics/{rubric_id}/leaderboards/{leaderboard_id}/' \
  -H 'Authorization: Api-Key <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
idstringrequired
namestring<= 100 charactersrequired

A descriptive name for the leaderboard.

descriptionstring

Optional description of the leaderboard.

date_createdstring(date-time)read-onlyrequired
date_updatedstring(date-time)(Last updated)read-onlyrequired
include_patternsstring(Include conditions)

Comma-separated list of conditions to include. Supports wildcards (*). Leave empty to include all methods.

exclude_patternsstring(Exclude conditions)

Comma-separated list of conditions to exclude. Supports wildcards. Applied after include patterns.

entriesArray of objectsread-onlyrequired
entries[].​property name*anyadditional property
Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "date_updated": "2019-08-24T14:15:22Z",
  "include_patterns": "string",
  "exclude_patterns": "string",
  "entries": [
    { … }
  ]
}

Metrics

Operations