---
title: Get instance statistics.
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[AI Search](https://developers.cloudflare.com/api/python/resources/ai_search)

[Instances](https://developers.cloudflare.com/api/python/resources/ai_search/subresources/instances)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get instance statistics.

Deprecated

aisearch.instances.stats(strid, InstanceStatsParams\*\*kwargs) -> [InstanceStatsResponse](<https://developers.cloudflare.com/api/python/resources/ai_search#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/ai-search/instances/{id}/stats

Retrieve usage and indexing statistics for an AI Search instance.

Deprecated: use /accounts/{account\_id}/ai-search/namespaces/{name}/instances (and descendant paths) instead.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

account\_id: str

[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20stats%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

id: str

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64

minLength1

[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20stats%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class InstanceStatsResponse: …

</summary>

completed: Optional\[int]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20completed">Link to this property</a>

degraded: Optional\[bool]

True when status counts are unavailable (e.g. legacy stats query exceeded D1 statement-size limit). Counts are omitted in this case.

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20degraded">Link to this property</a>

<details>

<summary>

engine: Optional\[Engine]

Engine-specific metadata. Present only for managed (v3) instances.

</summary>

<details>

<summary>

r2: Optional\[EngineR2]

R2 bucket storage usage in bytes.

</summary>

metadata\_size\_bytes: int

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20r2%20%3E%20(property)%20metadataSizeBytes">Link to this property</a>

object\_count: int

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20r2%20%3E%20(property)%20objectCount">Link to this property</a>

payload\_size\_bytes: int

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20r2%20%3E%20(property)%20payloadSizeBytes">Link to this property</a>

</details>

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20r2">Link to this property</a>

<details>

<summary>

vectorize: Optional\[EngineVectorize]

Vectorize index metadata (dimensions, vector count).

</summary>

dimensions: int

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20vectorize%20%3E%20(property)%20dimensions">Link to this property</a>

vectors\_count: int

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20vectorize%20%3E%20(property)%20vectorsCount">Link to this property</a>

</details>

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine%20%3E%20(property)%20vectorize">Link to this property</a>

</details>

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20engine">Link to this property</a>

error: Optional\[int]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20error">Link to this property</a>

file\_embed\_errors: Optional\[Dict\[str, object]]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20file_embed_errors">Link to this property</a>

index\_source\_errors: Optional\[Dict\[str, object]]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20index_source_errors">Link to this property</a>

last\_activity: Optional\[datetime]

formatdate-time

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20last_activity">Link to this property</a>

outdated: Optional\[int]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20outdated">Link to this property</a>

queued: Optional\[int]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20queued">Link to this property</a>

running: Optional\[int]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20running">Link to this property</a>

skipped: Optional\[int]

<a href="#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)%20%3E%20(property)%20skipped">Link to this property</a>

</details>

[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20instance_stats_response%20%3E%20(schema)>)

### Get instance statistics.

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.aisearch.instances.stats(
    id="my-ai-search",
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
)
print(response.completed)
```

200 example

```
{
  "result": {
    "completed": 0,
    "degraded": true,
    "engine": {
      "r2": {
        "metadataSizeBytes": 0,
        "objectCount": 0,
        "payloadSizeBytes": 0
      },
      "vectorize": {
        "dimensions": 0,
        "vectorsCount": 0
      }
    },
    "error": 0,
    "file_embed_errors": {
      "foo": "bar"
    },
    "index_source_errors": {
      "foo": "bar"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "outdated": 0,
    "queued": 0,
    "running": 0,
    "skipped": 0
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "result": {
    "completed": 0,
    "degraded": true,
    "engine": {
      "r2": {
        "metadataSizeBytes": 0,
        "objectCount": 0,
        "payloadSizeBytes": 0
      },
      "vectorize": {
        "dimensions": 0,
        "vectorsCount": 0
      }
    },
    "error": 0,
    "file_embed_errors": {
      "foo": "bar"
    },
    "index_source_errors": {
      "foo": "bar"
    },
    "last_activity": "2019-12-27T18:11:19.117Z",
    "outdated": 0,
    "queued": 0,
    "running": 0,
    "skipped": 0
  },
  "success": true
}
```