Preview a spec

Needs: Reports, Read

Checks a spec and calculates its results without saving. Use it before creating or editing an insight to confirm the numbers. It only reads, so it needs Reports Read.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/reports/insights/preview" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  }
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/reports/insights/preview"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/reports/insights/preview", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  }
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  }
}`)

    req, err := http.NewRequest("POST", "https://app.imploy.com.au/api/integrations/v1/reports/insights/preview", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app.imploy.com.au/api/integrations/v1/reports/insights/preview')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  }
}'

response = http.request(request)
puts response.body

{
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  },
  "results": {
    "available": true,
    "value": 480.5
  }
}

POST

/reports/insights/preview

POST

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Content-Typestring

Required

The media type of the request body

Options: application/json

specobject

Required

The insight settings, as in the Report Builder sidebar (Single mode). Send only what you set or change. Keys: source; metric (metricId::aggregation); visualization; group_by (a field, or null); breakdown_by (a second grouping, or null); filters ({field: value}, and {} clears); date_range; value_format; options; target (bar, area and line only; null removes it); formula and conditional_formatting (Metric only). Choosing a source resets its metric, groups, filters and formula. Use the options endpoint for the valid values.