POST
/
api
/
v1
/
reports
/
compare
/
Compare
curl --request POST \
  --url https://api.main.apexscore.ai/api/v1/reports/compare/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "comparison_ids": [
    "d561a959-7ee2-44c1-87ad-a497d5b51ee1",
    "a9853aca-542d-4126-bb08-757da33a6b96"
  ]
}'
{
  "portfolio": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "configurations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "is_primary": true,
      "portfolio": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "report": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "issued_at": "2023-11-07T05:31:56Z",
        "survey_start_date": "2023-12-25",
        "survey_end_date": "2023-12-25"
      },
      "mona_version": {
        "id": 123,
        "name": "<string>",
        "audience": "<string>",
        "audience_type": 0,
        "sequence": -1
      },
      "compared_with_configuration": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "report_name": "<string>",
        "report_issued_at": "2023-11-07T05:31:56Z"
      },
      "result": {
        "apex_score": 0,
        "potential_apex_score": 0,
        "population_size": -1,
        "rank": {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "minimum_differential": -1,
          "audience_type": 123,
          "mona_version": 123
        },
        "opportunity_driver_categories": "<string>",
        "fba": "<string>",
        "ppp": "<string>",
        "benchmark": {},
        "attitudes": {}
      }
    }
  ],
  "largest_apex_reached": "<string>",
  "avg_attitude_importance": "<string>",
  "avg_attitude_performance": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
group_configurations_by
enum<string>

Group lists of comparison items by one of their fields. This grouping is secondary to the separate_portfolios setting.

Available options:
issued_at,
portfolio
​
only_latest
boolean
default:false

Set to true to only return the latest configuration in the resulting data, for when you only care about the most recent results/comparison.

Body

application/json

The REQUEST serializer that takes a list of either Report IDs or Configuration IDs to compare.

The serializer preps all the objects to be compared and stores them in the configurations field.

​
comparison_ids
string<uuid>[]
required

Specify either Report IDs or Configuration IDs that should be used in the comparison. If an ID passed does not exist or the user does not have access, it will be ignored from the comparison.

​
save_name
string

Response

200 - application/json

This serializer represents the parent container and information for all configurations that are being compared.

It will contain some over-arching data about the comparison and then a list of ReportCompareConfigurationResponseSerializer

​
configurations
object[]
required

If a group_by is requested, this field will be returned as a dictionary of groupby_key: [ReportCompareConfigurationResponseSerializer] instead of a flat list.

​
largest_apex_reached
string
required
​
avg_attitude_importance
string
required
​
avg_attitude_performance
string
required
​
portfolio
object