Preview an unsaved report definition

curl --request POST \
  --url https://api.gratona.com/v1/admin/reports/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Follow up with trip participants",
  "module_id": 1,
  "hysform_id": "<unknown>",
  "sponsorships": "<unknown>",
  "type": "view",
  "fields": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": "<unknown>",
      "op": "<string>"
    }
  ],
  "filterGroups": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": "<unknown>",
      "op": "<string>"
    }
  ],
  "column_fields": [
    "<string>"
  ],
  "column_order": [
    "<string>"
  ],
  "date_range": {
    "preset": "all_time",
    "start_date": "2026-10-20",
    "end_date": "2026-10-20"
  },
  "sort_key": "<string>",
  "sort_order": "asc",
  "footer_calculations": [
    {
      "field_key": "<string>",
      "operation": "count_empty"
    }
  ],
  "search_query": "<string>",
  "related": {},
  "related_config": {},
  "snapshot": false
}
'

import requests

url = "https://api.gratona.com/v1/admin/reports/preview"

payload = {
    "name": "Follow up with trip participants",
    "module_id": 1,
    "hysform_id": "<unknown>",
    "sponsorships": "<unknown>",
    "type": "view",
    "fields": [
        {
            "field": "<string>",
            "operator": "<string>",
            "value": "<unknown>",
            "op": "<string>"
        }
    ],
    "filterGroups": [
        {
            "field": "<string>",
            "operator": "<string>",
            "value": "<unknown>",
            "op": "<string>"
        }
    ],
    "column_fields": ["<string>"],
    "column_order": ["<string>"],
    "date_range": {
        "preset": "all_time",
        "start_date": "2026-10-20",
        "end_date": "2026-10-20"
    },
    "sort_key": "<string>",
    "sort_order": "asc",
    "footer_calculations": [
        {
            "field_key": "<string>",
            "operation": "count_empty"
        }
    ],
    "search_query": "<string>",
    "related": {},
    "related_config": {},
    "snapshot": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Follow up with trip participants',
    module_id: 1,
    hysform_id: '<unknown>',
    sponsorships: '<unknown>',
    type: 'view',
    fields: [{field: '<string>', operator: '<string>', value: '<unknown>', op: '<string>'}],
    filterGroups: [{field: '<string>', operator: '<string>', value: '<unknown>', op: '<string>'}],
    column_fields: ['<string>'],
    column_order: ['<string>'],
    date_range: {preset: 'all_time', start_date: '2026-10-20', end_date: '2026-10-20'},
    sort_key: '<string>',
    sort_order: 'asc',
    footer_calculations: [{field_key: '<string>', operation: 'count_empty'}],
    search_query: '<string>',
    related: {},
    related_config: {},
    snapshot: false
  })
};

fetch('https://api.gratona.com/v1/admin/reports/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/reports/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Follow up with trip participants',
    'module_id' => 1,
    'hysform_id' => '<unknown>',
    'sponsorships' => '<unknown>',
    'type' => 'view',
    'fields' => [
        [
                'field' => '<string>',
                'operator' => '<string>',
                'value' => '<unknown>',
                'op' => '<string>'
        ]
    ],
    'filterGroups' => [
        [
                'field' => '<string>',
                'operator' => '<string>',
                'value' => '<unknown>',
                'op' => '<string>'
        ]
    ],
    'column_fields' => [
        '<string>'
    ],
    'column_order' => [
        '<string>'
    ],
    'date_range' => [
        'preset' => 'all_time',
        'start_date' => '2026-10-20',
        'end_date' => '2026-10-20'
    ],
    'sort_key' => '<string>',
    'sort_order' => 'asc',
    'footer_calculations' => [
        [
                'field_key' => '<string>',
                'operation' => 'count_empty'
        ]
    ],
    'search_query' => '<string>',
    'related' => [
        
    ],
    'related_config' => [
        
    ],
    'snapshot' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.gratona.com/v1/admin/reports/preview"

	payload := strings.NewReader("{\n  \"name\": \"Follow up with trip participants\",\n  \"module_id\": 1,\n  \"hysform_id\": \"<unknown>\",\n  \"sponsorships\": \"<unknown>\",\n  \"type\": \"view\",\n  \"fields\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"op\": \"<string>\"\n    }\n  ],\n  \"filterGroups\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"op\": \"<string>\"\n    }\n  ],\n  \"column_fields\": [\n    \"<string>\"\n  ],\n  \"column_order\": [\n    \"<string>\"\n  ],\n  \"date_range\": {\n    \"preset\": \"all_time\",\n    \"start_date\": \"2026-10-20\",\n    \"end_date\": \"2026-10-20\"\n  },\n  \"sort_key\": \"<string>\",\n  \"sort_order\": \"asc\",\n  \"footer_calculations\": [\n    {\n      \"field_key\": \"<string>\",\n      \"operation\": \"count_empty\"\n    }\n  ],\n  \"search_query\": \"<string>\",\n  \"related\": {},\n  \"related_config\": {},\n  \"snapshot\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/reports/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Follow up with trip participants\",\n  \"module_id\": 1,\n  \"hysform_id\": \"<unknown>\",\n  \"sponsorships\": \"<unknown>\",\n  \"type\": \"view\",\n  \"fields\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"op\": \"<string>\"\n    }\n  ],\n  \"filterGroups\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"op\": \"<string>\"\n    }\n  ],\n  \"column_fields\": [\n    \"<string>\"\n  ],\n  \"column_order\": [\n    \"<string>\"\n  ],\n  \"date_range\": {\n    \"preset\": \"all_time\",\n    \"start_date\": \"2026-10-20\",\n    \"end_date\": \"2026-10-20\"\n  },\n  \"sort_key\": \"<string>\",\n  \"sort_order\": \"asc\",\n  \"footer_calculations\": [\n    {\n      \"field_key\": \"<string>\",\n      \"operation\": \"count_empty\"\n    }\n  ],\n  \"search_query\": \"<string>\",\n  \"related\": {},\n  \"related_config\": {},\n  \"snapshot\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/reports/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Follow up with trip participants\",\n  \"module_id\": 1,\n  \"hysform_id\": \"<unknown>\",\n  \"sponsorships\": \"<unknown>\",\n  \"type\": \"view\",\n  \"fields\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"op\": \"<string>\"\n    }\n  ],\n  \"filterGroups\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"<string>\",\n      \"value\": \"<unknown>\",\n      \"op\": \"<string>\"\n    }\n  ],\n  \"column_fields\": [\n    \"<string>\"\n  ],\n  \"column_order\": [\n    \"<string>\"\n  ],\n  \"date_range\": {\n    \"preset\": \"all_time\",\n    \"start_date\": \"2026-10-20\",\n    \"end_date\": \"2026-10-20\"\n  },\n  \"sort_key\": \"<string>\",\n  \"sort_order\": \"asc\",\n  \"footer_calculations\": [\n    {\n      \"field_key\": \"<string>\",\n      \"operation\": \"count_empty\"\n    }\n  ],\n  \"search_query\": \"<string>\",\n  \"related\": {},\n  \"related_config\": {},\n  \"snapshot\": false\n}"

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

{
  "data": {
    "columns": [
      {
        "key": "<string>",
        "label": "<string>",
        "type": "<string>",
        "source": "<string>",
        "capabilities": {},
        "help": {}
      }
    ],
    "columnKeys": [
      "<string>"
    ],
    "rows": [
      {}
    ],
    "page": 123,
    "limit": 123,
    "total": 123,
    "rollups": {},
    "groups": [
      {}
    ],
    "rollups_included": true,
    "related": {},
    "available": true,
    "report": {
      "id": 123,
      "source": "<string>",
      "type": "<string>",
      "type_label": "<string>",
      "name": "<string>",
      "search_query": "<string>",
      "snapshot": true,
      "starred": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "module": {
        "id": 123,
        "key": "<string>",
        "label": "<string>"
      },
      "context": {
        "id": "<string>",
        "label": "<string>",
        "available": true
      },
      "filters": [
        {
          "field": "<string>",
          "operator": "<string>",
          "value": "<unknown>",
          "op": "<string>"
        }
      ],
      "columns": {
        "fields": [
          "<string>"
        ],
        "order": [
          "<string>"
        ],
        "labels": {},
        "definitions": [
          {
            "key": "<string>",
            "label": "<string>",
            "type": "<string>",
            "source": "<string>",
            "capabilities": {},
            "help": {}
          }
        ]
      },
      "field_labels": {},
      "date_range": {
        "preset": "all_time",
        "start_date": "2023-12-25",
        "end_date": "2023-12-25"
      },
      "footer_calculations": [
        {
          "field_key": "<string>",
          "operation": "count_empty"
        }
      ],
      "sort": {
        "key": "<string>",
        "order": "<string>"
      },
      "schedule": {},
      "schedule_entitlement": {
        "enabled": true,
        "locked": true
      },
      "related": {},
      "owner": {
        "id": 123
      },
      "open": {
        "path": "<string>",
        "query": {}
      },
      "missing_fields": {},
      "actions": {}
    },
    "data_status": "complete",
    "unavailable_columns": [
      {
        "key": "<string>",
        "label": "<string>",
        "type": "<string>",
        "source": "<string>",
        "capabilities": {},
        "help": {}
      }
    ],
    "currency_summary": {}
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}