Export documentation
  • 03 Jun 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Export documentation

  • Dark
    Light

POST/project/export

Start a new export


Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Body Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
entity string Area to export. It can be Project/Version/Category/Article
entity_ids string[] mandatory for other entities except 'Project' Id's of the given entity for other entities except Project
filter_by_article_modified_at object filter articles by modified at date range
exclude_media_files bool Exclude media files if its not needed

filter_by_article_modified_at

Parameter Type Description
after string filter the articles which are all modified after the given date
before string filter the articles which are all modified before the given date

Sample Request

To export the documentation at Project level

{
   "entity": "Project", // Version/Category/Article
   "entity_ids": [], // should be empty array 
   "filter_by_article_modified_at": {  // filter articles by modified at date range
       "after": "2021-05-17T03:42:52.109Z",
        "before": "2021-05-17T03:42:52.109Z"
   },
   "exclude_media_files": true 
}

To export the documentation at Version/Category/Article level

{
  "entity": "Version",
   "entity_ids": ["695782c0-a0a3-4664-9bfd-0197d26379ee"], // Pass ',' separated values for multiple versions
   "filter_by_article_modified_at": null,
   "exclude_media_files": true 
}

Sample Response

{
  "id": "4039df02-ccca-4461-b4a1-eec107a19de3",
  "status": "Initiated",
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Response Data

Parameter Type Description
id string ID of the export request. Use this ID to get export details
status string Current status of the export

Was this article helpful?