Kapa.ai (v1)

Download OpenAPI specification:Download

Terms of Service

API for Kapa.ai

Activity

Returns aggregate as well as time series statistics for a project

Authorizations:

Bearer

path Parameters

project_id

required

string

query Parameters

token_types	string Comma-separated list of token types to filter by. Available choices: SLACK, DISCORD, WIDGET, API, INTERNAL
start_date_time	string <date-time> Start datetime for filtering in ISO 8601 format (e.g., 2020-01-01T00:00:00Z).
end_date_time	string <date-time> End datetime for filtering in ISO 8601 format (e.g., 2020-01-01T23:59:59Z).
aggregation_period required	string Period for aggregating data. Available choices: HOUR, DAY, WEEK, MONTH, YEAR

Responses

Response samples

200

Content type

application/json

{"time_series": [{"period": "2019-08-24T14:15:22Z",
"total_count": 0,
"total_uncertain_count": 0,
"count_by_token_type": [{"token_type": "SLACK",
"count": 0,
"description": "string"
}
]
}
],
"aggregate_statistics": {"total_questions": 0,
"total_upvotes": 0,
"total_downvotes": 0,
"total_questions_uncertain": 0,
"total_questions_uncertain_or_downvoted": 0
}
}

Common Questions

Clusters

Returns a semantic clustering of threads for a project

Authorizations:

Bearer

path Parameters

project_id

required

string

query Parameters

confidence_filter	string Enum: "UNCERTAIN" "CERTAIN" Only include threads with specified confidence label
start_date_time	string <date-time> Start datetime for filtering in ISO 8601 format (e.g., 2020-01-01T00:00:00Z).
end_date_time	string <date-time> End datetime for filtering in ISO 8601 format (e.g., 2020-01-01T23:59:59Z).
cluster_mode	string Enum: "detailed" "broad" Mode for clustering

Responses

Response samples

200

Content type

application/json

{"threads_total": 0,
"threads_clustered": 0,
"threads_unclustered": 0,
"sufficient_data": true,
"clusters": [{"title": "string",
"threads": [{"id": "string",
"first_question": "string"
}
]
}
]
}

Source Analytics

Questions

Returns a list of questions answered through the sources of a project

Authorizations:

Bearer

path Parameters

project_id

required

string

query Parameters

page	integer Page number for pagination
page_size	integer Number of items per page for pagination
start_date	string <date-time> Start date for filtering, in ISO 8601 format (e.g., 2023-01-01T00:00:00Z).
end_date	string <date-time> End date for filtering, in ISO 8601 format (e.g., 2023-01-31T23:59:59Z).
url_path	string Specific URL path to filter the results by.

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question": "string",
"answer": "string",
"created_at": "2019-08-24T14:15:22Z",
"is_uncertain": true,
"total_upvotes": 0,
"total_downvotes": 0,
"thread_id": "string"
}
]

Statistics

Returns a list of source used by kapa to answer questions together with a count of questions answered by them.

Authorizations:

Bearer

path Parameters

project_id

required

string

query Parameters

page	integer Page number for pagination
page_size	integer Number of items per page for pagination
start_date	string <date-time> Start date for the data retrieval period in ISO 8601 format (e.g., 2020-01-01T00:00:00Z).
end_date	string <date-time> End date for the data retrieval period in ISO 8601 format (e.g., 2020-01-02T23:59:59Z).
url_path	string Specific URL path to filter the statistics by.

Responses

Response samples

200

Content type

application/json

[{"is_leaf": true,
"node_url": "string",
"count": 0,
"percentage_of_total": "string"
}
]

Top Sources

Returns a list of sources that were most used by kapa to answer user questions

Authorizations:

Bearer

path Parameters

project_id

required

string

query Parameters

start_date	string <date-time> Start date for the data retrieval period in ISO 8601 format (e.g., 2020-01-01T00:00:00Z).
end_date	string <date-time> End date for the data retrieval period in ISO 8601 format (e.g., 2020-01-01T23:59:59Z).
limit	integer Maximum number of top sources to retrieve.

Responses

Response samples

200

Content type

application/json

[{"node_url": "string",
"count": 0
}
]

Threads

Returns all threads for a project

Authorizations:

Bearer

path Parameters

project_id

required

string

query Parameters

page	integer Page number for pagination
page_size	integer Number of items per page for pagination
reaction_filter	string Enum: "UPVOTE" "DOWNVOTE" Filter by reaction type
confidence_filter	string Enum: "UNCERTAIN" "CERTAIN" Filter by confidence level
status_tag_filter	string <uuid> Filter by status tag id
start_date	string <date-time> Start date for filtering threads (YYYY-MM-DDTHH:MM:SSZ)
end_date	string <date-time> End date for filtering threads (YYYY-MM-DDTHH:MM:SSZ)
search_text	string Text to search within threads
token_filter	string Filter by specific token
sort_by_date	string Enum: "asc" "desc" Sort the results in the specified order by date. If not specified results are ordered by date in descending order.

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"token": {"id": 0,
"token_type": "SLACK",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"total_number_of_question_answers": 0
},
"total_upvotes": 0,
"total_downvotes": 0,
"total_comments": 0,
"total_number_of_question_answers": 0,
"created_at": "2019-08-24T14:15:22Z",
"initial_question": "string",
"is_uncertain": true,
"status_tag": "string",
"status_tag_id": "bcc09619-3a7b-4037-9d98-031f60c9ecfd"
}
]

Question Answers

Returns all question answers for a single thread

Authorizations:

Bearer

path Parameters

project_id required	string
id required	string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question": "string",
"answer": "string",
"created_at": "2019-08-24T14:15:22Z",
"is_uncertain": true,
"relevant_sources": "string",
"total_upvotes": 0,
"total_downvotes": 0,
"total_comments": 0,
"feedback": "string"
}
]