articles

Initiate a new Report

Initiate a new Article Report for this Account. There is a limit of 1 report per day.

post/account/articles/export

Request

Base URL
https://api.figshare.com/v2
Auth
OAuth 2
Authorization codehttps://figshare.com/account/applications/authorize
Token URLhttps://api.figshare.com/v2/token
Scopesall
TypeScript
https://skmtc.dev/figshare/apis/figshare-api/docs/account/articles/export/post.ts
A function with typed inputs. Its response is checked against the schema.

OK. AccountReport created.

idinteger required

A unique ID for the AccountRecord

account_idinteger required

The ID of the account which generated this report.

created_datestring required

Date when the AccountReport was requested

status'missing' | 'pending' | 'done' required

Status of the report

download_urlstring url required

The download link for the generated XLSX

group_idinteger required

The group ID that was used to filter the report, if any.

{
  "created_date": "2017-05-15T15:12:26Z",
  "download_url": "https://some.com/storage/path/123/report-456.xlsx"
}

Mar 27, 20265806e3dd43b2 Revision changes
- info
  added the media type application/json for the response with the status
Dec 7, 20228f3c4a6a6462 Revision changes
- info
  added the non-success response with the status