API Reference/Reports/Execute

Execute a report

POST
/api/reports/execute
AuthorizationBearer <token>

In: header

reportDefinitionIdstring
Format"uuid"
parameters?object

Empty Object

outputFormat?string
Default"json"
Value in"json" | "csv" | "pdf" | "excel"

Response Body

curl -X POST "http://localhost:3000/api/reports/execute" \
  -H "Content-Type: application/json" \
  -d '{
    "reportDefinitionId": "767e3469-96fa-48a2-b661-ada267945c4b"
  }'
const body = JSON.stringify({
  "reportDefinitionId": "767e3469-96fa-48a2-b661-ada267945c4b"
})

fetch("http://localhost:3000/api/reports/execute", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "http://localhost:3000/api/reports/execute"
  body := strings.NewReader(`{
    "reportDefinitionId": "767e3469-96fa-48a2-b661-ada267945c4b"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "http://localhost:3000/api/reports/execute"
body = {
  "reportDefinitionId": "767e3469-96fa-48a2-b661-ada267945c4b"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
  "reportName": "string",
  "executedAt": "2019-08-24T14:15:22Z",
  "data": [
    {}
  ],
  "summary": {}
}