Stats

client.AISearch.Namespaces.Instances.Stats(ctx, name, id, query) (*NamespaceInstanceStatsResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats

Retrieves usage statistics for AI Search instances.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

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

Example:X-Auth-Email: user@example.com

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

name string

id string

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

maxLength64

minLength1

query NamespaceInstanceStatsParams

AccountID param.Field[string]

ReturnsExpand Collapse

type NamespaceInstanceStatsResponse struct{…}

Completed int64Optional

Degraded boolOptional

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

Engine NamespaceInstanceStatsResponseEngineOptional

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

R2 NamespaceInstanceStatsResponseEngineR2Optional

R2 bucket storage usage in bytes.

MetadataSizeBytes int64

ObjectCount int64

PayloadSizeBytes int64

Vectorize NamespaceInstanceStatsResponseEngineVectorizeOptional

Vectorize index metadata (dimensions, vector count).

Dimensions int64

VectorsCount int64

Error int64Optional

FileEmbedErrors map[string, unknown]Optional

IndexSourceErrors map[string, unknown]Optional

LastActivity TimeOptional

formatdate-time

Outdated int64Optional

Queued int64Optional

Running int64Optional

Skipped int64Optional

Stats

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/ai_search"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.AISearch.Namespaces.Instances.Stats(
    context.TODO(),
    "my-namespace",
    "my-ai-search",
    ai_search.NamespaceInstanceStatsParams{
      AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Completed)
}

{
  "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

{
  "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
}