Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Data Usage Publishers API
description: The SASHIMI API represents a RESTful implementation of SUSHI automation intended to returns COUNTER Research Data Release 1 reports
termsOfService: ''
contact:
name: DataCite Data Usage API
url: https://metrics.stage.datacite.org
email: support@datacite.org
license:
name: MIT
url: https://raw.githubusercontent.com/datacite/sashimi/master/LICENSE
version: 1.0.0
servers:
- url: https://api.datacite.org
description: Production server
- url: https://metrics.stage.datacite.org
description: Staging server
security:
- Bearer: []
tags:
- name: publishers
paths:
/publishers:
get:
summary: This resource returns a collection of reports publishers.
tags:
- publishers
parameters:
- name: platform
in: query
description: Name of the Platform the usage is being requested for. This can be omitted if the service provides usage for only one platform.
schema:
type: string
- name: report_id
in: query
description: The report ID or code or shortname. Typically this will be the same code provided in the Report parameter of the request.
schema:
type: string
responses:
'200':
description: Collections of Usage Reports.
content:
application/json:
schema:
$ref: '#/definitions/Publisher'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/definitions/Error_Model'
post:
summary: This resource creates a new of report publisher.
tags:
- publishers
parameters: []
responses:
'200':
description: Publisher entity
content:
application/json:
schema:
$ref: '#/definitions/Publisher'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/definitions/Error_Model'
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/definitions/Publisher'
/publishers/{id}:
get:
summary: This resource returns a specific report publisher.
tags:
- publishers
parameters:
- name: id
in: path
description: Publisher Unique ID. Identifier of a specific report publisher.
required: true
schema:
type: string
responses:
'200':
description: Publisher Instance
content:
application/json:
schema:
$ref: '#/definitions/Publisher'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/definitions/Error_Model'
delete:
summary: This resource deletes a Publisher.
tags:
- publishers
parameters:
- name: id
in: path
description: Publisher Unique ID. Identifier of a specific report publisher.
required: true
schema:
type: string
responses:
'204':
description: The resource was deleted successfully.
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/definitions/Error_Model'
put:
summary: This resource returns an updated Publisher Record.
tags:
- publishers
parameters:
- name: id
in: path
description: Publisher Unique ID. Identifier of a specific report publisher.
required: true
schema:
type: string
responses:
'200':
description: Report Updated.
content:
application/json:
schema:
$ref: '#/definitions/Publisher'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/definitions/Error_Model'
components:
securitySchemes:
Bearer:
type: http
scheme: bearer
description: Token-based authentication for members