Text Topics - Apex Documentation

GET

/

api

/

v1

/

reports

/

{id}

/

summary

/

topics

/

Text Topics

curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/reports/{id}/summary/topics/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.main.apexscore.ai/api/v1/reports/{id}/summary/topics/"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.main.apexscore.ai/api/v1/reports/{id}/summary/topics/', 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.main.apexscore.ai/api/v1/reports/{id}/summary/topics/",
  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.main.apexscore.ai/api/v1/reports/{id}/summary/topics/"

	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.main.apexscore.ai/api/v1/reports/{id}/summary/topics/")

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

{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "key_focus_attitudes": "<string>",
      "themes": [
        {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "idea_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>"
        }
      ],
      "topic": "<string>",
      "key_focus_priority_order": -1,
      "dominant_sentiment": "positive",
      "category": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string<uuid>

required

A UUID string identifying this report.

Query Parameters

configuration_id

string<uuid>

Optional configuration id to retrieve. If not provided, the primary configuration will be used.

issued_at_after

string<date-time>

issued_at_before

string<date-time>

mona_version__audience_type

enum<integer>

0 - None
1 - Customers
2 - Employees
3 - Donors
4 - Media
5 - Gathering 2024 Lecturees

Available options:

0,

1,

2,

3,

4,

5

name

string

only_comparable

boolean

Set to true to only include Reports that are comparable at this time (which excludes sample reports and those marked for non-comparison or incomplete), and only their Configurations that are comparable and completed with a result.

only_key_focus_topics

boolean

Optional param to limit the results to only the top key focus topics.

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

portfolio_id__in

string<uuid>[]

Multiple values may be separated by commas.

tags

(enum<string> | null)[]

competitive - Competitive
segment - Segment
industry - Industry
none - None

Available options:

competitive,

industry,

none,

segment

Response

200 - application/json

count

integer

required

Example:

123

results

object[]

required

Show child attributes

next

string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

previous

string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"

Text Topics

curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/reports/{id}/summary/topics/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.main.apexscore.ai/api/v1/reports/{id}/summary/topics/"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.main.apexscore.ai/api/v1/reports/{id}/summary/topics/', 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.main.apexscore.ai/api/v1/reports/{id}/summary/topics/",
  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.main.apexscore.ai/api/v1/reports/{id}/summary/topics/"

	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.main.apexscore.ai/api/v1/reports/{id}/summary/topics/")

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

{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "key_focus_attitudes": "<string>",
      "themes": [
        {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "idea_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>"
        }
      ],
      "topic": "<string>",
      "key_focus_priority_order": -1,
      "dominant_sentiment": "positive",
      "category": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}