API Documentation
Endpoint Examples
- Metadata/Attitudes
- Authentication
- Comments
- Organization Invitations
- Organization Members
- Organizations
- Portfolios
- Metadata/Ranks
- Report Publishings
- Reports
- GETList
- POSTCreate
- GETRetrieve
- PUTUpdate
- DELDestroy
- PATCHPartial Update
- GETAttachments
- GETConfiguration Status
- GETDownload Dataset
- GETEntry Data
- POSTFilter
- GETFilterables
- GETObservations
- GETSummary
- GETPriority Composition
- GETText Topic Metadata Fields
- GETText Topics
- GETText Entries
- GETText Topics Sentiment Stats
- POSTCompare
- GET
- Segments
- Text Topic Theme Idea
- Datasets - Uploaded
- Users
- Metadata/Versions
Reports
Filter
POST
https://api.main.apexscore.ai
/
api
/
v1
/
reports
/
{id}
/
filter
curl --request POST \
--url https://api.main.apexscore.ai/api/v1/reports/{id}/filter/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"asynchronous": true,
"configuration_id": "2a822a99-2ffd-459d-bf1f-5c0f187b90bc",
"filters": [
{
"dataset_filterable_id": "6c58243e-f4ce-4295-abd8-d7d6df94996d",
"value": [
"55-64",
"45-54"
]
}
]
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tags": "competitive",
"issued_at": "2023-11-07T05:31:56Z",
"mona_version": {
"id": 123,
"name": "<string>",
"audience": "<string>",
"audience_type": 0,
"sequence": -1
},
"comments": "<string>",
"dataset": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"configurations": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_primary": true,
"copied_from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"industry_configuration": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"comments": "<string>",
"content_pages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"icon": "<string>",
"title": "<string>",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>"
}
}
],
"filters": [
{
"filterable": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"value": "<any>",
"operator": "<string>"
}
],
"result": {
"state": {
"status": "pending",
"status_message": "<string>",
"observations_data_pending": "<string>",
"text_analysis_data_pending": "<string>"
},
"apex_score": 0,
"potential_apex_score": 0,
"value_boxes": [
{
"name": "<string>",
"value": "<string>",
"icon": "<string>",
"impact_description": "<string>",
"description": "<string>"
}
],
"population_size": -1,
"rank": {
"id": 123,
"name": "<string>",
"description": "<string>",
"minimum_differential": -1,
"audience_type": 123,
"mona_version": 123
},
"opportunity_driver_categories": {},
"fba": {},
"ppp": {},
"analyses": {},
"benchmark": {},
"misc": {},
"attitudes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attitude_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"keyword": "<string>",
"description": "<string>",
"explanation": "<string>",
"classification": "FE",
"ppp_classification": "NA",
"seol": "<string>",
"performance_rebased": 0,
"importance_rebased": 0,
"performance_order": -1,
"importance_order": -1,
"performance_agreed": 0,
"importance_agreed": 0,
"fulfillment_balance": 0,
"fulfillment_ratio": 0,
"content_icon_url": "<string>",
"comments": {
"count": 123,
"commenters": [
{
"full_name": "<string>"
}
]
},
"content_recommendations": [
{
"header": "<string>",
"subtext": "<string>",
"example": "<string>",
"why": "<string>"
}
],
"content_studies": [
{
"title": "<string>",
"link": "<string>"
}
]
}
]
},
"filterables": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
]
}
},
"meta": "<any>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
A UUID string identifying this report.
Body
application/json
Response
200 - application/json
The response is of type object
.
curl --request POST \
--url https://api.main.apexscore.ai/api/v1/reports/{id}/filter/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"asynchronous": true,
"configuration_id": "2a822a99-2ffd-459d-bf1f-5c0f187b90bc",
"filters": [
{
"dataset_filterable_id": "6c58243e-f4ce-4295-abd8-d7d6df94996d",
"value": [
"55-64",
"45-54"
]
}
]
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tags": "competitive",
"issued_at": "2023-11-07T05:31:56Z",
"mona_version": {
"id": 123,
"name": "<string>",
"audience": "<string>",
"audience_type": 0,
"sequence": -1
},
"comments": "<string>",
"dataset": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"configurations": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_primary": true,
"copied_from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"industry_configuration": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"comments": "<string>",
"content_pages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"icon": "<string>",
"title": "<string>",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>"
}
}
],
"filters": [
{
"filterable": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"value": "<any>",
"operator": "<string>"
}
],
"result": {
"state": {
"status": "pending",
"status_message": "<string>",
"observations_data_pending": "<string>",
"text_analysis_data_pending": "<string>"
},
"apex_score": 0,
"potential_apex_score": 0,
"value_boxes": [
{
"name": "<string>",
"value": "<string>",
"icon": "<string>",
"impact_description": "<string>",
"description": "<string>"
}
],
"population_size": -1,
"rank": {
"id": 123,
"name": "<string>",
"description": "<string>",
"minimum_differential": -1,
"audience_type": 123,
"mona_version": 123
},
"opportunity_driver_categories": {},
"fba": {},
"ppp": {},
"analyses": {},
"benchmark": {},
"misc": {},
"attitudes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attitude_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"keyword": "<string>",
"description": "<string>",
"explanation": "<string>",
"classification": "FE",
"ppp_classification": "NA",
"seol": "<string>",
"performance_rebased": 0,
"importance_rebased": 0,
"performance_order": -1,
"importance_order": -1,
"performance_agreed": 0,
"importance_agreed": 0,
"fulfillment_balance": 0,
"fulfillment_ratio": 0,
"content_icon_url": "<string>",
"comments": {
"count": 123,
"commenters": [
{
"full_name": "<string>"
}
]
},
"content_recommendations": [
{
"header": "<string>",
"subtext": "<string>",
"example": "<string>",
"why": "<string>"
}
],
"content_studies": [
{
"title": "<string>",
"link": "<string>"
}
]
}
]
},
"filterables": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
]
}
},
"meta": "<any>"
}
Assistant
Responses are generated using AI and may contain mistakes.