Spaces

Read a mention summary card

Requires the configured page-editor feature (spaces by default) and current subject/page access. Workspace pages use a null subject; subject pages inherit their space access. The document must occur in an accessible page. Search and recent additionally require edit access to an active page. Read resolution never grants access to the mentioned record. Below full disclosure only disclosure is returned; detail fields and donation aggregates appear only when the caller may read them.

GET

admin

mentions

summary

Read a mention summary card

curl --request GET \
  --url https://api.gratona.com/v1/admin/mentions/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/mentions/summary', 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/mentions/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.gratona.com/v1/admin/mentions/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/mentions/summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "disclosure": {
      "key": "<string>",
      "level": "<string>",
      "type": "<string>",
      "type_label": "<string>",
      "display": "<string>",
      "url": "<string>",
      "available": true,
      "program_type": "<string>",
      "mentioned_by": "<string>",
      "inactive": true,
      "requested": true
    },
    "subtitle": "<string>",
    "fields": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "image_url": "<string>",
    "badges": [
      "<string>"
    ]
  }
}

{
  "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."
}

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

document_uuid

string<uuid>

required

Document uuid.

version_id

integer | null

Version id.

Required range: x >= 1

kind

enum<string>

required

Kind.

Available options:

record,

user,

page

related_type

string | null

Related type.

Maximum string length: 32

related_id

integer | null

Related id.

Required range: x >= 1

page_uuid

string | null

Page uuid.

Maximum string length: 64

Response

Read a mention summary card response.

data

object

Show child attributes

Read a mention summary card

curl --request GET \
  --url https://api.gratona.com/v1/admin/mentions/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/mentions/summary', 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/mentions/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.gratona.com/v1/admin/mentions/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/mentions/summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "disclosure": {
      "key": "<string>",
      "level": "<string>",
      "type": "<string>",
      "type_label": "<string>",
      "display": "<string>",
      "url": "<string>",
      "available": true,
      "program_type": "<string>",
      "mentioned_by": "<string>",
      "inactive": true,
      "requested": true
    },
    "subtitle": "<string>",
    "fields": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "image_url": "<string>",
    "badges": [
      "<string>"
    ]
  }
}

{
  "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."
}

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