Impact Stories
Preview a story import batch
Stores an import receipt and at most 25 preview rows. This step does not import stories. Requires the impact_stories feature. Requires permission: one of impact_stories_import.
POST
/
admin
/
impact-stories
/
imports
/
preview
Preview a story import batch
curl --request POST \
--url https://api.gratona.com/v1/admin/impact-stories/imports/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_type": "manual",
"source_name": "Source Name",
"upload_id": 1,
"mapping_json": {},
"rows": [
"<unknown>"
]
}
'import requests
url = "https://api.gratona.com/v1/admin/impact-stories/imports/preview"
payload = {
"source_type": "manual",
"source_name": "Source Name",
"upload_id": 1,
"mapping_json": {},
"rows": ["<unknown>"]
}
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({
source_type: 'manual',
source_name: 'Source Name',
upload_id: 1,
mapping_json: {},
rows: ['<unknown>']
})
};
fetch('https://api.gratona.com/v1/admin/impact-stories/imports/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/impact-stories/imports/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([
'source_type' => 'manual',
'source_name' => 'Source Name',
'upload_id' => 1,
'mapping_json' => [
],
'rows' => [
'<unknown>'
]
]),
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/impact-stories/imports/preview"
payload := strings.NewReader("{\n \"source_type\": \"manual\",\n \"source_name\": \"Source Name\",\n \"upload_id\": 1,\n \"mapping_json\": {},\n \"rows\": [\n \"<unknown>\"\n ]\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/impact-stories/imports/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_type\": \"manual\",\n \"source_name\": \"Source Name\",\n \"upload_id\": 1,\n \"mapping_json\": {},\n \"rows\": [\n \"<unknown>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/impact-stories/imports/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 \"source_type\": \"manual\",\n \"source_name\": \"Source Name\",\n \"upload_id\": 1,\n \"mapping_json\": {},\n \"rows\": [\n \"<unknown>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"client_id": 42,
"upload_id": 42,
"created_by_user_id": 42,
"source_type": "Education update",
"status": "Education update",
"source_name": "Education update",
"mapping_json": {},
"preview_rows_json": [
{}
],
"errors_json": [
{
"row": 2,
"message": "Education update"
}
],
"row_count": 2,
"created_count": 2,
"updated_count": 2,
"skipped_count": 2,
"processed_at": "2026-10-20T12:00:00Z",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z"
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Body
application/json
Validated request fields for this operation.
Source type. Validation: nullable, string, max:64.
Maximum string length:
64Example:
"manual"
Source name. Validation: nullable, string, max:255.
Maximum string length:
255Example:
"Source Name"
Upload id. Validation: nullable, integer.
Example:
1
Mapping json. Validation: nullable, array.
Show child attributes
Show child attributes
Rows. Validation: nullable, array.
Response
Operation result.
Import receipt. Preview retains at most 25 sample rows; processing accepts at most 500 supplied rows and reports skipped rows.
Show child attributes
Show child attributes
⌘I
Preview a story import batch
curl --request POST \
--url https://api.gratona.com/v1/admin/impact-stories/imports/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_type": "manual",
"source_name": "Source Name",
"upload_id": 1,
"mapping_json": {},
"rows": [
"<unknown>"
]
}
'import requests
url = "https://api.gratona.com/v1/admin/impact-stories/imports/preview"
payload = {
"source_type": "manual",
"source_name": "Source Name",
"upload_id": 1,
"mapping_json": {},
"rows": ["<unknown>"]
}
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({
source_type: 'manual',
source_name: 'Source Name',
upload_id: 1,
mapping_json: {},
rows: ['<unknown>']
})
};
fetch('https://api.gratona.com/v1/admin/impact-stories/imports/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/impact-stories/imports/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([
'source_type' => 'manual',
'source_name' => 'Source Name',
'upload_id' => 1,
'mapping_json' => [
],
'rows' => [
'<unknown>'
]
]),
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/impact-stories/imports/preview"
payload := strings.NewReader("{\n \"source_type\": \"manual\",\n \"source_name\": \"Source Name\",\n \"upload_id\": 1,\n \"mapping_json\": {},\n \"rows\": [\n \"<unknown>\"\n ]\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/impact-stories/imports/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_type\": \"manual\",\n \"source_name\": \"Source Name\",\n \"upload_id\": 1,\n \"mapping_json\": {},\n \"rows\": [\n \"<unknown>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/impact-stories/imports/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 \"source_type\": \"manual\",\n \"source_name\": \"Source Name\",\n \"upload_id\": 1,\n \"mapping_json\": {},\n \"rows\": [\n \"<unknown>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"client_id": 42,
"upload_id": 42,
"created_by_user_id": 42,
"source_type": "Education update",
"status": "Education update",
"source_name": "Education update",
"mapping_json": {},
"preview_rows_json": [
{}
],
"errors_json": [
{
"row": 2,
"message": "Education update"
}
],
"row_count": 2,
"created_count": 2,
"updated_count": 2,
"skipped_count": 2,
"processed_at": "2026-10-20T12:00:00Z",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z"
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}