OpenAI Administration Connector

Intro

This article explains how to use Domo’s OpenAI Administration Connector to pull organization administration data, including audit logs, users, projects, API keys, usage, and costs. This connector uses the OpenAI Admin API and requires an Admin API key (sk-admin-…) with appropriate organization scopes. Usage and cost reports require Lookup Days and Bucket Width.

---

Prerequisites

To connect to the OpenAI Administration API and create a DataSet, you need the AdminAPI Key associated with your OpenAI Administration account. Learn how to create an Admin API Key.

This article covers the fields and menus specific to the OpenAI Administration Connector user interface. For general information about adding DataSets, setting update schedules, and editing DataSet information, see Add a DataSet Using a Data Connector.

Configure the Connection

This section describes the options in the Credentials and Details panes on the OpenAI Administration Connector page. The components of the Scheduling and Name & Describe Your DataSet panes are universal across most connector types and are discussed in Add a DataSet Using a Data Connector.

Enter Your Credentials

The Credentials pane contains the field for entering credentials to connect to the OpenAI Administration API. The following table describes what is needed for each field.

Field	Description
API Key	Enter your Admin API key. If you do not have one, create an Admin API key.

After you have entered valid credentials, you can use the same account any time you set up a new Domo-OpenAI Administration connection. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage User Accounts for Connectors.

Configure the Details Pane

This pane contains a primary Reports menu, along with various other menus for configuring your report.

Menu	Description
Report	Select the OpenAI administration report to retrieve. For list reports (such as Users and Projects), the date range is ignored. Usage and Costs reports require a lookback window and bucket width.. The following reports are available: Report Admin API Keys Audit Logs Costs Costs (Partition) Invites Project API Keys Project Rate Limits Project Service Accounts Project Users Projects Usage - Audio Speeches Usage - Audio Transcriptions Usage - Code Interpreter Sessions Usage - Completions Usage - Embeddings Usage - Images Usage - Moderations Usage - Vector Stores Users
Date Range	Select a date range to retrieve the data.
Usage Bucket Width	Specifies the time bucket granularity for usage reports. Select one of the following options: 1 minute, 1 hour, or 1 day.
Group By	Optional. Specify comma-separated fields to group usage or cost results. Usage supports: project_id, user_id, api_key_id, model, and batch. Costs supports: project_id, line_item, and api_key_id. Leave blank to apply no grouping.
Backfill Months	Specifies the number of months to load on the first run. Defaults to 24 for the Cost Partition report.
Restate Months	Specifies the number of recent months to refresh on each subsequent run. Defaults to 6 for the Cost Partition report. The value must be less than or equal to Backfill Months.

Configure Other Options

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Add a DataSet Using a Data Connector.