Series Data

API methods for conversation series data

Available conversation series resources

GET https://api.context.ai/api/v1/conversations/series

200: OK Indicates a successful response

{
    "available": [
        "sentiment",
        "rating",
        "estimated_cost",
        "volume"
    ]
}

Sentiment score series data

GET https://api.context.ai/api/v1/conversations/series/sentiment

Average sentiment score grouped by period. Defaults to the last week of data.

Query Parameters

Name	Type	Description
start_time	String	ISO-8601 timestamp indicating the start of data to consider. Defaults to 7 days ago.
end_time	String	ISO-8601 timestamp indicating the end of data to consider. Defaults to now.
tenant_id	String	The tenant_id for conversations to consider.
period	String	Period to group data by. Defaults to day. Options are: day, week or month.

200: OK Indicates a successful response

{
    "series": [
        {
            "name": "Sentiment",
            "data": [
                [
                    "2023-11-09",
                    0.15
                ],
                [
                    "2023-11-10",
                    0.0
                ],
                [
                    "2023-11-11",
                    0.04
                ],
                [
                    "2023-11-12",
                    0.08
                ],
                [
                    "2023-11-13",
                    0.1
                ],
                [
                    "2023-11-14",
                    0.0
                ],
                [
                    "2023-11-15",
                    null
                ]
            ]
        }
    ],
    "type": "sentiment",
    "period": "day",
    "start_time": "2023-11-09T00:00:00.000Z",
    "end_time": "2023-11-15T11:03:49.000Z"
}

Rating series data

GET https://api.context.ai/api/v1/conversations/series/rating

Average ratings grouped by period. Defaults to the last week of data.

Query Parameters

Name	Type	Description
start_time	String	ISO-8601 timestamp indicating the start of data to consider. Defaults to 7 days ago.
end_time	String	ISO-8601 timestamp indicating the end of data to consider. Defaults to now.
tenant_id	String	The tenant_id for conversations to consider.
period	String	Period to group data by. Defaults to day. Options are: day, week or month.

200: OK Indicates a successful response

{
    "series": [
        {
            "name": "Rating",
            "data": [
                [
                    "2023-11-09",
                    0.0
                ],
                [
                    "2023-11-10",
                    0.0
                ],
                [
                    "2023-11-11",
                    0.0
                ],
                [
                    "2023-11-12",
                    0.0
                ],
                [
                    "2023-11-13",
                    0.0
                ],
                [
                    "2023-11-14",
                    0.0
                ],
                [
                    "2023-11-15",
                    0.0
                ]
            ]
        }
    ],
    "type": "rating",
    "period": "day",
    "start_time": "2023-11-09T00:00:00.000Z",
    "end_time": "2023-11-15T11:13:35.000Z"
}

Estimated cost series data

GET https://api.context.ai/api/v1/conversations/series/estimated_cost

Average estimated cost grouped by period. Defaults to the last week of data.

Query Parameters

Name	Type	Description
start_time	String	ISO-8601 timestamp indicating the start of data to consider. Defaults to 7 days ago.
end_time	String	ISO-8601 timestamp indicating the end of data to consider. Defaults to now.
tenant_id	String	The tenant_id for conversations to consider.
period	String	Period to group data by. Defaults to day. Options are: day, week or month.

200: OK Indicates a successful response

{
    "series": [
        {
            "name": "claude-2",
            "data": [
                [
                    "2023-11-10",
                    1.55
                ],
                [
                    "2023-11-11",
                    2.82
                ],
                [
                    "2023-11-12",
                    0.0
                ],
                [
                    "2023-11-13",
                    0.9
                ]
            ]
        },
        {
            "name": "gpt-3.5-turbo-4k",
            "data": [
                [
                    "2023-11-10",
                    0.55
                ],
                [
                    "2023-11-11",
                    0.0
                ],
                [
                    "2023-11-12",
                    0.0
                ],
                [
                    "2023-11-13",
                    0.12
                ]
            ]
        }
    ],
    "type": "estimated_cost",
    "period": "day",
    "start_time": "2023-11-10T00:00:00.000Z",
    "end_time": "2023-11-13T11:15:32.000Z"
}

Conversation volume series data

GET https://api.context.ai/api/v1/conversations/series/volume

Average conversation volume grouped by period. Defaults to the last week of data.

Query Parameters

Name	Type	Description
start_time	String	ISO-8601 timestamp indicating the start of data to consider. Defaults to 7 days ago.
end_time	String	ISO-8601 timestamp indicating the end of data to consider. Defaults to now.
tenant_id	String	The tenant_id for conversations to consider.
period	String	Period to group data by. Defaults to day. Options are: day, week or month.

200: OK Indicates a successful response

{
    "series": [
        {
            "name": "Volume",
            "data": [
                [
                    "2023-11-09",
                    3
                ],
                [
                    "2023-11-10",
                    8
                ],
                [
                    "2023-11-11",
                    12
                ],
                [
                    "2023-11-12",
                    6
                ],
                [
                    "2023-11-13",
                    5
                ],
                [
                    "2023-11-14",
                    14
                ],
                [
                    "2023-11-15",
                    0
                ]
            ]
        }
    ],
    "type": "volume",
    "period": "day",
    "start_time": "2023-11-09T00:00:00.000Z",
    "end_time": "2023-11-15T11:18:52.000Z"
}