Zatomic
API Reference

The Heatmap Object

NOTE: When generating heatmaps of prompts stored outside of Zatomic, the version_timestamp and heatmap_timestamp properties will both be null.

Properties
version_timestamp
datetime, nullable
 The timestamp of the prompt version used to generate the heatmap.
heatmap_timestamp
datetime, nullable
 The timestamp for when the heatmap was generated.
summary
object

Properties of the summary object:

overall_feedback
string
 The overall feedback for the heatmap analysis.
phrases
list of objects

Properties of the phrases object:

phrase
string
 The prompt phrase.
attention_score
integer
 The attenton score assigned to the phrase. Will be a whole number from 1 - 5.
color
string
 The color level for the phrase, based on its attention score. Will be very-light, light, medium, dark, or very-dark.
reason
string
 The reason why the AI model assigned the phrase its attention score.
The Heatmap Object 
{
   "version_timestamp": "2024-12-19T20:33:15.971617Z",
   "heatmap_timestamp": "2024-12-19T20:33:15.971617Z",
   "summary": {
      "overall_feedback": "Overall feedback for the heatmap analysis."
   },
   "phrases": [
      {
         "phrase": "The prompt phrase.",
         "attention_score": 1,
         "color": "The color level assigned to the phrase.",
         "reason": "The reason why the AI model assigned the phrase its attention score."
      }
   ]
}