}

/v1/ - Endpoint Overview

Web API Base URL:

https://api.reporting.cloud/

Method Endpoint Description
Delete
account/apikey Deletes a ReportingCloud API Key from the list of existing API Keys.
Put
account/apikey Creates and stores a new ReportingCloud API Key to list of API keys.
Get
account/apikeys Lists all available ReportingCloud API keys from the existing keys.
Get
account/settings Returns detailed information about the account quota and general settings.
Post
document/append Combines documents by appending them divided by a new section, paragraph or nothing.
Post
document/convert Converts a document to another supported format.
Post
document/findandreplace Executes a find and replace on a template to create a document.
Post
document/merge Merges and returns a compatible template from the template storage or an uploaded template with hierarchical JSON data.
Get
document/share Returns an encrypted document name that can be used in the ReportingCloud Viewer widget.
Get
fonts/list Returns a list of available fonts that can be used in templates. All Google Fonts are installed on all ReportingCloud instances.
Get
proofing/availabledictionaries Returns all available dictionaries for supported proofing languages.
Get
proofing/check Checks text for spelling errors.
Get
proofing/suggestions Returns suggestions for a misspelled word.
Get
templates/count Returns the number of templates in the template storage.
Delete
templates/delete Deletes a template from the ReportingCloud template storage.
Get
templates/download Returns the selected template from the storage.
Get
templates/exists Checks whether a template exists in the template storage.
Get
templates/info Returns information about the template including hierarchical structure of merge fields and merge blocks.
Get
templates/list Lists all templates from the ReportingCloud template storage.
Get
templates/pagecount Returns the number of pages of a template in the template storage.
Get
templates/thumbnails Creates and returns thumbnail images of template pages.
Post
templates/upload Stores an uploaded template in the ReportingCloud template storage. Supported template formats are Microsoft Word (.doc), WordProcessingML (.docx), Rich Text Format (.rtf) and TX Text Control Format (.tx).