Get an insight

Needs: Reports, Read

Returns one insight: its settings as a spec (what create and edit accept), its link, its spaces, and its results (value, grouped rows and cells) when the server can calculate them. Otherwise it says why not.

Note: Settings made in Imploy that a spec cannot express are listed as set_in_imploy. The results shape depends on the visualization, so only the common keys are shown.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/reports/insights/123?include_results=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/reports/insights/123?include_results=true"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/reports/insights/123?include_results=true", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

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

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app.imploy.com.au/api/integrations/v1/reports/insights/123?include_results=true", nil)
    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/123?include_results=true')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

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

{
  "id": 31,
  "name": "Hours by week",
  "spec": {
    "source": "appointments",
    "metric": "hours::sum",
    "visualization": "bar",
    "group_by": "week",
    "date_range": {
      "preset": "3m"
    }
  },
  "results": {
    "available": true,
    "value": 480.5,
    "rows": [
      "..."
    ]
  }
}