> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# エージェント会話トピックを取得

GET https://api.elevenlabs.io/v1/convai/agents/{agent_id}/topics

指定されたエージェントの最新トピック検出実行結果を返します。

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/conversations/topics/get

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Path parameters

- `agent_id` (string, required) — エージェントのID

### Query parameters

- `page_size` (integer, optional) — 返す最上位トピックグループ数です。
- `sort_by` (enum, optional) — トピックのランキングに使用する列です。件数にはconversations、最もネガティブなトピックにはsort_direction=ascを指定したsentiment、最もフラストレーションの高いトピックにはsort_direction=descを指定したfrustrationを使用します。スコアのないトピックは常に最後にランク付けされます。
  - Allowed values: `conversations`, `sentiment`, `success_rate`, `frustration`
- `sort_direction` (enum, optional) — トピックのソート順。
  - Allowed values: `asc`, `desc`
- `from_unix_secs` (integer, optional) — トピックを表示する期間の開始時刻。to_unix_secsと併せて設定すると、範囲内で完了した日次トピック検出の実行が集計されるため、この期間はトピックセットだけでなく指標の範囲も定めます。実行はUTC日の全体を対象とするため、UTC日の開始時刻に切り捨てられます。aggregated_run_countは集計された実行数を示します。両方の境界を省略すると、最新の単一実行を取得します。
- `to_unix_secs` (integer, optional) — トピックを表示する期間の終了。
- `include_evaluation_criteria` (boolean, optional, default: true) — 各トピックのメトリクスに、基準ごとの評価内訳を含めます。除外するにはfalseを指定してください。この内訳はペイロードの大半を占めますが、加重success_rateはいずれの場合も返されます。
- `cursor` (string, optional) — 次のページを取得するために使用します。カーソルはレスポンスで返されます。

## Response

### 200

成功レスポンス。

- `topics` (list of AgentTopicResponseModel, required)
- `window_start_unix_secs` (integer, required)
- `window_end_unix_secs` (integer, required)
- `aggregated_run_count` (integer, optional, default: 0) — 返されたメトリクスの合計対象となった、トピック検出の日次実行回数です。
- `has_more` (boolean, optional, default: false)
- `next_cursor` (string, optional)

## Errors

### 422 Topics Get Request Unprocessable Entity Error

検証エラー

- `detail` (list of ValidationError, optional)

## Types

### AgentTopicResponseModel

- `topic_id` (string, required)
- `label` (string, required)
- `description` (string, required)
- `conversation_count` (integer, required)
- `parent_topic_id` (string, optional)
- `x_2d` (double, optional)
- `y_2d` (double, optional)
- `metrics` (TopicMetricsAggregate, optional)
- `success_rate` (double, optional) — スコアリング済み会話で重み付けした、トピックの評価基準全体における成功率。include_evaluation_criteriaに関係なく返されます。

### ValidationError

- `loc` (list of ValidationErrorLocItem, required)
- `msg` (string, required)
- `type` (string, required)

### TopicMetricsAggregate

- `conversation_count` (integer, optional, default: 0)
- `sentiment` (TopicSentimentAggregate, optional)
- `evaluation_criteria` (list of TopicEvaluationCriteriaAggregate, optional)

### ValidationErrorLocItem

### TopicSentimentAggregate

- `sentiment` (NumericDistributionAggregate, optional)
- `frustration` (NumericDistributionAggregate, optional)
- `positive_count` (integer, optional, default: 0)
- `neutral_count` (integer, optional, default: 0)
- `negative_count` (integer, optional, default: 0)

### TopicEvaluationCriteriaAggregate

- `criteria_id` (string, required)
- `success_count` (integer, optional, default: 0)
- `failure_count` (integer, optional, default: 0)
- `unknown_count` (integer, optional, default: 0)

### NumericDistributionAggregate

- `count` (integer, optional, default: 0)
- `sum` (double, optional, default: 0)
- `min` (double, optional)
- `max` (double, optional)

## Examples

**Response**

```json
{
  "topics": [
    {
      "topic_id": "topic_id",
      "label": "label",
      "description": "description",
      "conversation_count": 1,
      "parent_topic_id": "parent_topic_id",
      "x_2d": 1.1,
      "y_2d": 1.1,
      "success_rate": 1.1
    }
  ],
  "window_start_unix_secs": 1,
  "window_end_unix_secs": 1,
  "aggregated_run_count": 1,
  "has_more": true,
  "next_cursor": "next_cursor"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/agents/agent_id/topics"

querystring = {"cursor":"cursor","from_unix_secs":"1","include_evaluation_criteria":"true","page_size":"1","sort_by":"conversations","sort_direction":"asc","to_unix_secs":"1"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/agents/agent_id/topics?cursor=cursor&from_unix_secs=1&include_evaluation_criteria=true&page_size=1&sort_by=conversations&sort_direction=asc&to_unix_secs=1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```