Builder options
Needs: Reports, Read
Returns what an insight can use, exactly as the Report Builder offers it: data sources, metrics, group-by fields, filters (with values), visualizations and their options, value formats, date ranges, and the formula and conditional formatting rules. Without source it lists the sources and visualizations. With source it lists that source's metrics, group-bys and filter values.
Note: A
resultsflag marks what this server can calculate. Anything else is still saved and shows in Imploy. The exact lists depend on your organisation, so the values shown are placeholders.
curl -X GET "https://app.imploy.com.au/api/integrations/v1/reports/options?source=example_string&date_range=example_string" \
-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/options?source=example_string&date_range=example_string"
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/options?source=example_string&date_range=example_string", {
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/options?source=example_string&date_range=example_string", 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/options?source=example_string&date_range=example_string')
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
{
"sources": [
{
"id": "appointments"
}
],
"visualizations": [
"..."
]
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Too many requests."
}
/reports/options
Target server for requests. Edit to use your own host.
An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
imp_at_. Send it as Authorization: Bearer imp_at_XXXX.A source id. Omit for the list of sources and visualizations.
A date range for appointment and finance filter values, sent as JSON. Defaults to the last 7 days. Send as JSON text.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Query Parameters
A source id. Omit for the list of sources and visualizations.
A date range for appointment and finance filter values, sent as JSON. Defaults to the last 7 days. Send as JSON text.
Responses
OK