API Reference

Admin

Organization

Usage

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Web search calls

client.Admin.Organization.Usage.WebSearchCalls(ctx, query) (*AdminOrganizationUsageWebSearchCallsResponse, error)

GET/organization/usage/web_search_calls

Get web search calls usage details for the organization.

ParametersExpand Collapse

query AdminOrganizationUsageWebSearchCallsParams

StartTime param.Field[int64]

Start time (Unix seconds) of the query time range, inclusive.

APIKeyIDs param.Field[[]string]Optional

Return only usage for these API keys.

BucketWidth param.Field[AdminOrganizationUsageWebSearchCallsParamsBucketWidth]Optional

Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

const AdminOrganizationUsageWebSearchCallsParamsBucketWidth1m AdminOrganizationUsageWebSearchCallsParamsBucketWidth = "1m"

const AdminOrganizationUsageWebSearchCallsParamsBucketWidth1h AdminOrganizationUsageWebSearchCallsParamsBucketWidth = "1h"

const AdminOrganizationUsageWebSearchCallsParamsBucketWidth1d AdminOrganizationUsageWebSearchCallsParamsBucketWidth = "1d"

ContextLevels param.Field[[]string]Optional

Return only web search usage for these context levels.

const AdminOrganizationUsageWebSearchCallsParamsContextLevelLow AdminOrganizationUsageWebSearchCallsParamsContextLevel = "low"

const AdminOrganizationUsageWebSearchCallsParamsContextLevelMedium AdminOrganizationUsageWebSearchCallsParamsContextLevel = "medium"

const AdminOrganizationUsageWebSearchCallsParamsContextLevelHigh AdminOrganizationUsageWebSearchCallsParamsContextLevel = "high"

EndTime param.Field[int64]Optional

End time (Unix seconds) of the query time range, exclusive.

GroupBy param.Field[[]string]Optional

Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, context_level or any combination of them.

const AdminOrganizationUsageWebSearchCallsParamsGroupByProjectID AdminOrganizationUsageWebSearchCallsParamsGroupBy = "project_id"

const AdminOrganizationUsageWebSearchCallsParamsGroupByUserID AdminOrganizationUsageWebSearchCallsParamsGroupBy = "user_id"

const AdminOrganizationUsageWebSearchCallsParamsGroupByAPIKeyID AdminOrganizationUsageWebSearchCallsParamsGroupBy = "api_key_id"

const AdminOrganizationUsageWebSearchCallsParamsGroupByModel AdminOrganizationUsageWebSearchCallsParamsGroupBy = "model"

const AdminOrganizationUsageWebSearchCallsParamsGroupByContextLevel AdminOrganizationUsageWebSearchCallsParamsGroupBy = "context_level"

Limit param.Field[int64]Optional

Specifies the number of buckets to return.

• bucket_width=1d: default: 7, max: 31
• bucket_width=1h: default: 24, max: 168
• bucket_width=1m: default: 60, max: 1440

Models param.Field[[]string]Optional

Return only usage for these models.

Page param.Field[string]Optional

A cursor for use in pagination. Corresponding to the next_page field from the previous response.

ProjectIDs param.Field[[]string]Optional

Return only usage for these projects.

UserIDs param.Field[[]string]Optional

Return only usage for these users.

ReturnsExpand Collapse

type AdminOrganizationUsageWebSearchCallsResponse struct{…}

Data []AdminOrganizationUsageWebSearchCallsResponseData

EndTime int64

Object Bucket

Results []AdminOrganizationUsageWebSearchCallsResponseDataResultUnion

One of the following:

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageCompletionsResult struct{…}

The aggregated completions usage details of the specific time bucket.

InputTokens int64

The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

NumModelRequests int64

The count of requests made to the model.

Object OrganizationUsageCompletionsResult

OutputTokens int64

The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Batch boolOptional

When group_by=batch, this field tells whether the grouped usage result is batch or not.

InputAudioTokens int64Optional

The aggregated number of uncached audio input tokens used.

InputCacheWriteTokens int64Optional

The aggregated number of input tokens written to the cache.

InputCachedAudioTokens int64Optional

The aggregated number of cached audio input tokens used.

InputCachedImageTokens int64Optional

The aggregated number of cached image input tokens used.

InputCachedTextTokens int64Optional

The aggregated number of cached text input tokens used.

InputCachedTokens int64Optional

The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

InputImageTokens int64Optional

The aggregated number of uncached image input tokens used.

InputTextTokens int64Optional

The aggregated number of uncached text input tokens used, excluding cache-write tokens.

InputUncachedTokens int64Optional

The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

OutputAudioTokens int64Optional

The aggregated number of audio output tokens used.

OutputImageTokens int64Optional

The aggregated number of image output tokens used.

OutputTextTokens int64Optional

The aggregated number of text output tokens used.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

ServiceTier stringOptional

When group_by=service_tier, this field provides the service tier of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageEmbeddingsResult struct{…}

The aggregated embeddings usage details of the specific time bucket.

InputTokens int64

The aggregated number of input tokens used.

NumModelRequests int64

The count of requests made to the model.

Object OrganizationUsageEmbeddingsResult

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageModerationsResult struct{…}

The aggregated moderations usage details of the specific time bucket.

InputTokens int64

The aggregated number of input tokens used.

NumModelRequests int64

The count of requests made to the model.

Object OrganizationUsageModerationsResult

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageImagesResult struct{…}

The aggregated images usage details of the specific time bucket.

Images int64

The number of images processed.

NumModelRequests int64

The count of requests made to the model.

Object OrganizationUsageImagesResult

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

Size stringOptional

When group_by=size, this field provides the image size of the grouped usage result.

Source stringOptional

When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageAudioSpeechesResult struct{…}

The aggregated audio speeches usage details of the specific time bucket.

Characters int64

The number of characters processed.

NumModelRequests int64

The count of requests made to the model.

Object OrganizationUsageAudioSpeechesResult

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageAudioTranscriptionsResult struct{…}

The aggregated audio transcriptions usage details of the specific time bucket.

NumModelRequests int64

The count of requests made to the model.

Object OrganizationUsageAudioTranscriptionsResult

Seconds int64

The number of seconds processed.

formatint64

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageVectorStoresResult struct{…}

The aggregated vector stores usage details of the specific time bucket.

Object OrganizationUsageVectorStoresResult

UsageBytes int64

The vector stores usage in bytes.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageCodeInterpreterSessionsResult struct{…}

The aggregated code interpreter sessions usage details of the specific time bucket.

NumSessions int64

The number of code interpreter sessions.

Object OrganizationUsageCodeInterpreterSessionsResult

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageFileSearchesResult struct{…}

The aggregated file search calls usage details of the specific time bucket.

NumRequests int64

The count of file search calls.

Object OrganizationUsageFileSearchesResult

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

VectorStoreID stringOptional

When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationUsageWebSearchesResult struct{…}

The aggregated web search calls usage details of the specific time bucket.

NumModelRequests int64

The count of model requests.

NumRequests int64

The count of web search calls.

Object OrganizationUsageWebSearchesResult

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

ContextLevel stringOptional

When group_by=context_level, this field provides the search context size of the grouped usage result.

Model stringOptional

When group_by=model, this field provides the model name of the grouped usage result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped usage result.

UserID stringOptional

When group_by=user_id, this field provides the user ID of the grouped usage result.

type AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationCostsResult struct{…}

The aggregated costs details of the specific time bucket.

Object OrganizationCostsResult

Amount AdminOrganizationUsageWebSearchCallsResponseDataResultOrganizationCostsResultAmountOptional

The monetary value in its associated currency.

Currency stringOptional

Lowercase ISO-4217 currency e.g. “usd”

Value float64Optional

The numeric value of the cost.

APIKeyID stringOptional

When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

LineItem stringOptional

When group_by=line_item, this field provides the line item of the grouped costs result.

ProjectID stringOptional

When group_by=project_id, this field provides the project ID of the grouped costs result.

Quantity float64Optional

When group_by=line_item, this field provides the quantity of the grouped costs result.

StartTime int64

HasMore bool

NextPage string

Object Page

Web search calls

Go

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAdminAPIKey("My Admin API Key"),
  )
  response, err := client.Admin.Organization.Usage.WebSearchCalls(context.TODO(), openai.AdminOrganizationUsageWebSearchCallsParams{
    StartTime: 0,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.web_searches.result",
                    "num_model_requests": 2,
                    "num_requests": 2,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null,
                    "context_level": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Returns Examples

{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.web_searches.result",
                    "num_model_requests": 2,
                    "num_requests": 2,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null,
                    "context_level": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}