Last 7 days, UTC

Average Latency
343ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Query Authentication
 

Get your keys at https://app.actualreports.com/admin#. Details on the parameters below can be found at http://actualreports.com/api


Authentication
Description
Parameter
String

your public key to identify your account

apikey

Required

String

unique email to identify which user is accessing the platform

email

Required

String

current time measured in the number of seconds since the Unix Epoch

timestamp

Required

String

unique hash for every request to ensure that the query is valid.

signature

Required

Endpoints

HTTP 200 : Get list of templates Response Model GET/template
						{
  "response": [
    {
      "id": 14817,
      "name": "Packing slip",
      "modified": "2013-09-23 09:10:27",
      "owner": false,
      "tags": [
        "packing"
      ]
    },
    {
      "id": 14815,
      "name": "Invoice",
      "modified": "2013-09-23 09:10:16",
      "owner": false,
      "tags": [
        "invoice"
      ]
    },
    {
      "id": 14830,
      "name": "Product Shelf Label (for label printer)",
      "modified": "2013-09-23 09:10:08",
      "owner": false,
      "tags": [
        "labels"
      ]
    },
    {
      "id": 14831,
      "name": "Address and Mailing label",
      "modified": "2013-09-23 09:09:27",
      "owner": false,
      "tags": [
        "mailing labels"
      ]
    }
  ],
  "meta": [
    
  ]
}						
Get list of templates

Returns list of templates availbale for the user. NB! This response is cached for 2 minutes.


Test console
Description
Parameter
string

'public' Return public templates; 'organization' Return organization templates; 'private' Return private templates. Filter templates by access rights
Example: public, organization, private

access

Optional

string

0 Returns response from cahce; 1 Force to refresh the response. Use this parameter to clear cache.

breakcache

Optional

HTTP 200 : Merge data with template Response Model POST/template/{id}/output
						{
  "response": "JVBERi0xLjcKJeLjz9MKNiAwIG9iago8....",
  "meta": {
    "encoding": "base64",
    "content-type": "application\/pdf"
  }
}						
Merge data with template

Merges data with the template and returns output in specified format. You can aquire #{id} using the /template request.


Test console
Description
Parameter
string

id

Required

string

pdf html
Example: pdf

format

Optional

string

S Returns output as string; I Shows output inline (e.g in browser); D Starts automatic download; base64 Returns file in base64 encoding. S returns output in response body. Values I and D expect you to redirect user to URL. base64 returns usual json response.
Example: D

output

Optional

string

0 or 1. Set value 1 to automatically open print dialog when file is opened or loaded in browser
Example: 0

print

Optional

string

'json'; 'csv' Semicolon separated; 'csv;' Semicolon separated; 'csv,' Comma separated; 'xls' Microsoft Excel 2007 and older; 'xlsx' Microsoft Excel
Example: json

dataformat

Optional

string

A list of items given as string or url in supported dataformat

data

Optional

HTTP 200 : Get list of templates Response Model GET/editor
						{
  "response": [
    {
      "id": 14817,
      "name": "Packing slip",
      "modified": "2013-09-23 09:10:27",
      "owner": false,
      "tags": [
        "packing"
      ]
    },
    {
      "id": 14815,
      "name": "Invoice",
      "modified": "2013-09-23 09:10:16",
      "owner": false,
      "tags": [
        "invoice"
      ]
    },
    {
      "id": 14830,
      "name": "Product Shelf Label (for label printer)",
      "modified": "2013-09-23 09:10:08",
      "owner": false,
      "tags": [
        "labels"
      ]
    },
    {
      "id": 14831,
      "name": "Address and Mailing label",
      "modified": "2013-09-23 09:09:27",
      "owner": false,
      "tags": [
        "mailing labels"
      ]
    }
  ],
  "meta": [
    
  ]
}						
Show editor

Redirecting your users to this url allows them to create and edit their templates. You can also display it inside the iframe. We reccomend you to always send the data parameter to give your user context, and preview ability when creating the template


Test console
Description
Parameter
string

template

Optional

string

json csv Semicolon separated csv; Semicolon separated csv, Comma separated xls Microsoft Excel 2007 and older xlsx Microsoft Excel
Example: json

dataformat

Optional

string

A list of items given as string or url in supported dataformat

data

Optional

string

0 Use regular editor design 1 Use minified editor design. Switch between minified and regular editor design
Example: 0

iframe

Optional

Consume this API completely for free!


By joining the mashape API marketplace you can start using Actual Reports API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.