|
<< Click to Display Table of Contents >> Raynet One Data Hub > 2026.2 > Connectors > Alphabetic Connector List > OpenAI > Connector Parameters Task Parameters |
Task parameters control which OpenAI usage data is collected and how the query is scoped. Each task must specify a query type, and most query types support additional filter parameters to narrow the result set.
This parameter defines the type of usage data to collect. Each query type maps to one or more OpenAI API endpoints. Selecting all collects data from all available endpoints in a single task run. Selecting generic also collects data from all endpoints but uses a unified set of filter parameters instead of endpoint-specific ones.
Technical Name |
type |
Category |
Functional |
Type |
Select |
Default Value |
n/a |
Available Options |
•audio_speeches •audio_transcriptions •code_interpreter_sessions •completions •costs •embeddings •images •moderations •vectorstores •projects •users •api_keys •all •generic |
The following parameters are available for most usage-based query types (audio_speeches, audio_transcriptions, completions, costs, embeddings, images, moderations, vectorstores, and all). For the generic query type, equivalent parameters with the generic- prefix apply to all endpoints at once.
The start of the query time range. This value is inclusive. Only usage records with a timestamp on or after this date are returned. A start time must be provided for all usage-based query types.
Technical Name |
<type>-StartTime |
Category |
Functional |
Type |
Date |
Default Value |
n/a |
Example Values |
2024-01-01 |
The end of the query time range. This value is exclusive. Only usage records with a timestamp before this date are returned. If omitted, the query returns data up to the current time.
Technical Name |
<type>-EndTime |
Category |
Functional |
Type |
Date |
Default Value |
n/a |
Example Values |
2024-01-31 |
Defines the width of each time bucket in the response. Results are aggregated into buckets of the specified width. Supported values are 1m (one minute), 1h (one hour), and 1d (one day). The default is 1d.
Technical Name |
<type>-BucketWidth |
Category |
Functional |
Type |
String |
Default Value |
1d |
Example Values |
1m, 1h, 1d |
Groups the usage data by one or more dimensions. Supported grouping fields are project_id, user_id, api_key_id, and model. Multiple values can be specified as a comma-separated list. If omitted, results are not grouped.
Technical Name |
<type>-GroupBy |
Category |
Functional |
Type |
String |
Default Value |
n/a |
Example Values |
project_id, model, project_id,user_id |
Limits the number of objects returned per API request. The value must be between 1 and 100. The default is 20. When the result set is larger than the limit, the connector automatically retrieves subsequent pages.
Technical Name |
<type>-Limit |
Category |
Functional |
Type |
Integer |
Default Value |
20 |
Example Values |
20, 50, 100 |
Filters the results to include only usage for the specified models. Multiple model names can be provided as a comma-separated list. If omitted, usage for all models is returned. This parameter is available for audio_speeches, audio_transcriptions, completions, embeddings, images, moderations, and all.
Technical Name |
<type>-Models |
Category |
Functional |
Type |
String |
Default Value |
n/a |
Example Values |
gpt-4, gpt-4-turbo, dall-e-3 |
Filters the results to include only usage for the specified projects. Multiple project IDs can be provided as a comma-separated list. If omitted, usage for all projects is returned.
Technical Name |
<type>-ProjectIds |
Category |
Functional |
Type |
String |
Default Value |
n/a |
Example Values |
proj_abc123, proj_abc123,proj_def456 |
Filters the results to include only usage for the specified users. Multiple user IDs can be provided as a comma-separated list. If omitted, usage for all users is returned. This parameter is available for audio_speeches, audio_transcriptions, completions, embeddings, images, moderations, and all.
Technical Name |
<type>-UserIds |
Category |
Functional |
Type |
String |
Default Value |
n/a |
Example Values |
user_abc, user_abc,user_def |
Filters the results to include only usage associated with the specified API keys. Multiple API key IDs can be provided as a comma-separated list. This parameter is available for audio_speeches, audio_transcriptions, completions, costs, embeddings, images, moderations, and all.
Technical Name |
<type>-ApiKeyIds |
Category |
Functional |
Type |
String |
Default Value |
n/a |
Example Values |
key_abc123 |
The following parameters apply only to specific query types.
Filters the completions results by batch status. If set to true, only batch jobs are returned. If set to false, only non-batch jobs are returned. If omitted, both batch and non-batch jobs are included.
Technical Name |
completion-Batch |
Applies To |
completions, all |
Type |
Boolean |
Default Value |
n/a (both included) |
Example Values |
true, false |
Filters image usage results by the source of the image operation. Supported values are image.generation, image.edit, and image.variation. Multiple values can be provided as a comma-separated list.
Technical Name |
image-Sources |
Applies To |
images, all |
Type |
String |
Default Value |
n/a (all sources) |
Example Values |
image.generation, image.edit,image.variation |
Filters image usage results by the image size. Supported values are 256x256, 512x512, 1024x1024, 1792x1792, and 1024x1792. Multiple values can be provided as a comma-separated list.
Technical Name |
image-Sizes |
Applies To |
images, all |
Type |
String |
Default Value |
n/a (all sizes) |
Example Values |
1024x1024, 256x256,512x512 |
When set to true, archived projects are included in the results. By default, archived projects are excluded.
Technical Name |
project-Archived |
Applies To |
projects, all |
Type |
Boolean |
Default Value |
false |
Example Values |
true, false |
Filters the user list by email address. Multiple email addresses can be provided as a comma-separated list.
Technical Name |
user-Email |
Applies To |
users, all |
Type |
String |
Default Value |
n/a (all users) |
Example Values |
john.doe@example.com,jane.doe@example.com |