Endpoints

This schema needs to be built on pipeline by running the script to build it as JSON. Once it's run, then running mkdocs build will create a file that can then be pushed up into S3 for content delivery.

Endpoint schema

Custom title 2.5.0

Here's a longer description of the custom OpenAPI schema

---

Insight endpoints

GET /get_insight_last_result

Do Get Insight Last Result

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "insight_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "insight_uuid": {
            "type": "string",
            "title": "Insight Uuid"
        }
    },
    "type": "object",
    "required": [
        "insight_uuid"
    ],
    "title": "Body_do_get_insight_last_result_get_insight_last_result_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Endpoints

GET /get_all_highlights_for_tracker_value

Do Get All Highlights For Tracker Value

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string",
    "tracker_value_str": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        },
        "tracker_value_str": {
            "type": "string",
            "title": "Tracker Value Str"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid",
        "tracker_value_str"
    ],
    "title": "Body_do_get_all_highlights_for_tracker_value_get_all_highlights_for_tracker_value_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /get_campaign_data

Do Get Campaign Data

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid"
    ],
    "title": "Body_do_get_campaign_data_get_campaign_data_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /get_campaign_theme_data

Do Get Campaign Theme Data

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid"
    ],
    "title": "Body_do_get_campaign_theme_data_get_campaign_theme_data_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /read_insight_grid_data

Do Read Insight Grid Data

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string",
    "grouping_column_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        },
        "grouping_column_uuid": {
            "type": "string",
            "title": "Grouping Column Uuid"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid"
    ],
    "title": "Body_do_read_insight_grid_data_read_insight_grid_data_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /read_insight_grid_data_by_filtered_data_efs_key

Do Read Insight Grid Data By Filtered Data Efs Key

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "filtered_data_efs_key": "string",
    "grouping_column_uuid": "string",
    "filters": [
        null
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "filtered_data_efs_key": {
            "type": "string",
            "title": "Filtered Data Efs Key"
        },
        "grouping_column_uuid": {
            "type": "string",
            "title": "Grouping Column Uuid"
        },
        "filters": {
            "items": {},
            "type": "array",
            "title": "Filters"
        }
    },
    "type": "object",
    "required": [
        "filtered_data_efs_key",
        "filters"
    ],
    "title": "Body_do_read_insight_grid_data_by_filtered_data_efs_key_read_insight_grid_data_by_filtered_data_efs_key_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /read_campaign_trend_data

Do Read Campaign Trend Data

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid"
    ],
    "title": "Body_do_read_campaign_trend_data_read_campaign_trend_data_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /get_unique_values_for_tracker

Do Get Unique Values For Tracker

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string",
    "tracker_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        },
        "tracker_uuid": {
            "type": "string",
            "title": "Tracker Uuid"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid",
        "tracker_uuid"
    ],
    "title": "Body_do_get_unique_values_for_tracker_get_unique_values_for_tracker_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /get_campaign_uuids

Do Get Campaign Uuids

Input parameters

Parameter	In	Type	Default	Nullable	Description
X-API-Key	header	string		No

Request body

application/json

{
    "campaign_uuid": "string"
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "campaign_uuid": {
            "type": "string",
            "title": "Campaign Uuid"
        }
    },
    "type": "object",
    "required": [
        "campaign_uuid"
    ],
    "title": "Body_do_get_campaign_uuids_get_campaign_uuids_get"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Content

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

Schemas

Body_do_get_all_highlights_for_tracker_value_get_all_highlights_for_tracker_value_get

Name	Type
campaign_uuid	string
tracker_value_str	string

Body_do_get_campaign_data_get_campaign_data_get

Name	Type
campaign_uuid	string

Body_do_get_campaign_theme_data_get_campaign_theme_data_get

Name	Type
campaign_uuid	string

Body_do_get_campaign_uuids_get_campaign_uuids_get

Name	Type
campaign_uuid	string

Body_do_get_insight_last_result_get_insight_last_result_get

Name	Type
insight_uuid	string

Body_do_get_unique_values_for_tracker_get_unique_values_for_tracker_get

Name	Type
campaign_uuid	string
tracker_uuid	string

Body_do_read_campaign_trend_data_read_campaign_trend_data_get

Name	Type
campaign_uuid	string

Body_do_read_insight_grid_data_by_filtered_data_efs_key_read_insight_grid_data_by_filtered_data_efs_key_get

Name	Type
filtered_data_efs_key	string
filters	Array<>
grouping_column_uuid	string

Body_do_read_insight_grid_data_read_insight_grid_data_get

Name	Type
campaign_uuid	string
grouping_column_uuid	string

HTTPValidationError

Name	Type
detail	Array<ValidationError>

ValidationError

Name	Type
loc	Array<>
msg	string
type	string