API Reference

Get customer intelligence.

get
https://app.customgpt.ai/api/v1/projects//reports/intelligence

Returns AI-analyzed insights about your users, including common intents, emotional sentiment, frequently discussed topics, and emerging trends. Use this to understand what users are asking about and how they're feeling.

Path Params
integer
required

The ID of the project to get customer intelligence for

Query Params
integer
Defaults to 1

Page number to return.

integer
Defaults to 100

Number of items to return per page. Maximum is 100.

date-time

Start of the date range for the intelligence report. ISO 8601 datetime format (e.g., 2024-01-15T00:00:00Z). Data from this point onward is included in the response.

date-time

End of the date range for the intelligence report. ISO 8601 datetime format (e.g., 2024-03-31T23:59:59Z). Data up to this point is included in the response.

content_source[]
array of strings

Filter results by Content Source (use repeated parameters, e.g. content_source[]=value)

content_source[]
string

Filter results by Verified Claims Score as range (format: min-max, e.g., 0-100)

stakeholder_status[]
array of strings

Filter results by Stakeholder Status (use repeated parameters, e.g. stakeholder_status[]=value)

stakeholder_status[]
user_emotion[]
array of strings

Filter results by User Emotion (use repeated parameters, e.g. user_emotion[]=value)

user_emotion[]
user_intent[]
array of strings

Filter results by User Intent (use repeated parameters, e.g. user_intent[]=value)

user_intent[]
language[]
array of strings

Filter results by Query Language (use repeated parameters, e.g. language[]=value)

language[]
user_id[]
array of strings

Filter results by Query Sent By (use repeated parameters, e.g. user_id[]=value)

user_id[]
external_id[]
array of strings

Filter results by CRM ID (use repeated parameters, e.g. external_id[]=value)

external_id[]
country[]
array of strings

Filter results by User Location (use repeated parameters, e.g. country[]=value)

country[]
risk_fidelity[]
array of strings

Filter results by Risk: Fidelity (use repeated parameters, e.g. risk_fidelity[]=value)

risk_fidelity[]
risk_jailbreak[]
array of strings

Filter results by Risk: Jailbreak (use repeated parameters, e.g. risk_jailbreak[]=value)

risk_jailbreak[]
risk_prompt_leakage[]
array of strings

Filter results by Risk: Prompt Leakage (use repeated parameters, e.g. risk_prompt_leakage[]=value)

risk_prompt_leakage[]
risk_profanity[]
array of strings

Filter results by Risk: Profanity (use repeated parameters, e.g. risk_profanity[]=value)

risk_profanity[]
request_source[]
array of strings

Filter results by Deployment (use repeated parameters, e.g. request_source[]=value)

request_source[]
leads[]
array of integers

Filter results by Lead Captured (use repeated parameters, e.g. leads[]=value)

leads[]
Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago