Skip to main content
Server path: /openai-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
openai_admin_activate_organization_certificatesActivate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time.
openai_admin_activate_project_certificatesActivate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time.
openai_admin_archive_projectArchives a project in the organization. Archived projects cannot be used or updated.
openai_admin_create_projectCreate a new project in the organization. Projects can be created and archived, but cannot be deleted.
openai_admin_create_project_service_accountCreates a new service account in the project. This also returns an unredacted API key for the service account.
openai_admin_create_project_userAdds a user to the project. Users must already be members of the organization to be added to a project.
openai_admin_deactivate_organization_certificatesDeactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time.
openai_admin_deactivate_project_certificatesDeactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.
openai_admin_delete_certificateDelete a certificate from the organization. The certificate must be inactive for the organization and all projects.
openai_admin_delete_inviteDelete an invite. If the invite has already been accepted, it cannot be deleted.
openai_admin_delete_project_api_keyDeletes an API key from the project.
openai_admin_delete_project_service_accountDeletes a service account from the project.
openai_admin_delete_project_userDeletes a user from the project.
openai_admin_delete_userDeletes a user from the organization.
openai_admin_get_certificateGet a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not.
openai_admin_invite_userCreate an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
openai_admin_list_audit_logsList user actions and configuration changes within this organization.
openai_admin_list_invitesReturns a list of invites in the organization.
openai_admin_list_organization_certificatesList uploaded certificates for this organization.
openai_admin_list_project_api_keysReturns a list of API keys in the project.
openai_admin_list_project_certificatesList certificates for this project.
openai_admin_list_project_rate_limitsReturns the rate limits per model for a project.
openai_admin_list_project_service_accountsReturns a list of service accounts in the project.
openai_admin_list_project_usersReturns a list of users in the project.
openai_admin_list_projectsReturns a list of projects.
openai_admin_list_usersLists all of the users in the organization.
openai_admin_modify_certificateModify a certificate. Note that only the name can be modified.
openai_admin_modify_projectModifies a project in the organization.
openai_admin_modify_project_userModifies a user’s role in the project.
openai_admin_modify_userModifies a user’s role in the organization.
openai_admin_retrieve_inviteRetrieves an invite.
openai_admin_retrieve_projectRetrieves a project.
openai_admin_retrieve_project_api_keyRetrieves an API key in the project.
openai_admin_retrieve_project_service_accountRetrieves a service account in the project.
openai_admin_retrieve_project_userRetrieves a user in the project.
openai_admin_retrieve_userRetrieves a user by their identifier.
openai_admin_update_project_rate_limitsUpdates a project rate limit.
openai_admin_upload_certificateUpload a certificate to the organization. This does not automatically activate the certificate. Organizations can upload up to 50 certificates.
openai_admin_usage_audio_speechesGet audio speeches usage details for the organization.
openai_admin_usage_audio_transcriptionsGet audio transcriptions usage details for the organization.
openai_admin_usage_code_interpreter_sessionsGet code interpreter sessions usage details for the organization.
openai_admin_usage_completionsGet completions usage details for the organization.
openai_admin_usage_costsGet costs details for the organization.
openai_admin_usage_embeddingsGet embeddings usage details for the organization.
openai_admin_usage_imagesGet images usage details for the organization.
openai_admin_usage_moderationsGet moderations usage details for the organization.
openai_admin_usage_vector_storesGet vector stores usage details for the organization.

openai_admin_activate_organization_certificates

Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time. Parameters:
ParameterTypeRequiredDefaultDescription
certificate_idsstring[]YesCertificate Ids

openai_admin_activate_project_certificates

Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
certificate_idsstring[]YesCertificate Ids

openai_admin_archive_project

Archives a project in the organization. Archived projects cannot be used or updated. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.

openai_admin_create_project

Create a new project in the organization. Projects can be created and archived, but cannot be deleted. Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe friendly name of the project, this name appears in reports.

openai_admin_create_project_service_account

Creates a new service account in the project. This also returns an unredacted API key for the service account. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
namestringYesThe name of the service account being created.

openai_admin_create_project_user

Adds a user to the project. Users must already be members of the organization to be added to a project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
rolestringYesowner or member
user_idstringYesThe ID of the user.

openai_admin_deactivate_organization_certificates

Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time. Parameters:
ParameterTypeRequiredDefaultDescription
certificate_idsstring[]YesCertificate Ids

openai_admin_deactivate_project_certificates

Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
certificate_idsstring[]YesCertificate Ids

openai_admin_delete_certificate

Delete a certificate from the organization. The certificate must be inactive for the organization and all projects. Parameters:
ParameterTypeRequiredDefaultDescription
certificate_idstringYesThe ID of the certificate.

openai_admin_delete_invite

Delete an invite. If the invite has already been accepted, it cannot be deleted. Parameters:
ParameterTypeRequiredDefaultDescription
invite_idstringYesThe ID of the invite to delete.

openai_admin_delete_project_api_key

Deletes an API key from the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
key_idstringYesThe ID of the API key.

openai_admin_delete_project_service_account

Deletes a service account from the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
service_account_idstringYesThe ID of the service account.

openai_admin_delete_project_user

Deletes a user from the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
user_idstringYesThe ID of the user.

openai_admin_delete_user

Deletes a user from the organization. Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe ID of the user.

openai_admin_get_certificate

Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not. Parameters:
ParameterTypeRequiredDefaultDescription
certificate_idstringYesUnique ID of the certificate to retrieve.
includestring[]NoA list of additional fields to include in the response. Currently the only supported value is content to fetch the PEM content of the certificate.

openai_admin_invite_user

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization. Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesSend an email to this address
projectsobject[]NoAn array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior.
rolestringYesowner or reader

openai_admin_list_audit_logs

List user actions and configuration changes within this organization. Parameters:
ParameterTypeRequiredDefaultDescription
effective_atobjectNoReturn only events whose effective_at (Unix seconds) is in this range.
project_ids[]string[]NoReturn only events for these projects.
event_types[]string[]NoReturn only events with a type in one of these values. For example, project.created. For all options, see the documentation for the audit log object.
actor_ids[]string[]NoReturn only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.
actor_emails[]string[]NoReturn only events performed by users with these emails.
resource_ids[]string[]NoReturn only events performed on these targets. For example, a project ID updated.
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
beforestringNoA cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

openai_admin_list_invites

Returns a list of invites in the organization. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

openai_admin_list_organization_certificates

List uploaded certificates for this organization. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
orderstringNoSort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

openai_admin_list_project_api_keys

Returns a list of API keys in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

openai_admin_list_project_certificates

List certificates for this project. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
orderstringNoSort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
project_idstringYesThe ID of the project.

openai_admin_list_project_rate_limits

Returns the rate limits per model for a project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
limitintegerNoA limit on the number of objects to be returned. The default is 100.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
beforestringNoA cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

openai_admin_list_project_service_accounts

Returns a list of service accounts in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

openai_admin_list_project_users

Returns a list of users in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

openai_admin_list_projects

Returns a list of projects. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
include_archivedbooleanNoIf true returns all projects including those that have been archived. Archived projects are not included by default.

openai_admin_list_users

Lists all of the users in the organization. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
afterstringNoA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
emailsstring[]NoFilter by the email address of users.

openai_admin_modify_certificate

Modify a certificate. Note that only the name can be modified. Parameters:
ParameterTypeRequiredDefaultDescription
certificate_idstringYesThe ID of the certificate.
namestringYesThe updated name for the certificate

openai_admin_modify_project

Modifies a project in the organization. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
namestringYesThe updated name of the project, this name appears in reports.

openai_admin_modify_project_user

Modifies a user’s role in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
user_idstringYesThe ID of the user.
rolestringYesowner or member

openai_admin_modify_user

Modifies a user’s role in the organization. Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe ID of the user.
rolestringYesowner or reader

openai_admin_retrieve_invite

Retrieves an invite. Parameters:
ParameterTypeRequiredDefaultDescription
invite_idstringYesThe ID of the invite to retrieve.

openai_admin_retrieve_project

Retrieves a project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.

openai_admin_retrieve_project_api_key

Retrieves an API key in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
key_idstringYesThe ID of the API key.

openai_admin_retrieve_project_service_account

Retrieves a service account in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
service_account_idstringYesThe ID of the service account.

openai_admin_retrieve_project_user

Retrieves a user in the project. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
user_idstringYesThe ID of the user.

openai_admin_retrieve_user

Retrieves a user by their identifier. Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe ID of the user.

openai_admin_update_project_rate_limits

Updates a project rate limit. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project.
rate_limit_idstringYesThe ID of the rate limit.
batch_1_day_max_input_tokensintegerNoThe maximum batch input tokens per day. Only relevant for certain models.
max_audio_megabytes_per_1_minuteintegerNoThe maximum audio megabytes per minute. Only relevant for certain models.
max_images_per_1_minuteintegerNoThe maximum images per minute. Only relevant for certain models.
max_requests_per_1_dayintegerNoThe maximum requests per day. Only relevant for certain models.
max_requests_per_1_minuteintegerNoThe maximum requests per minute.
max_tokens_per_1_minuteintegerNoThe maximum tokens per minute.

openai_admin_upload_certificate

Upload a certificate to the organization. This does not automatically activate the certificate. Organizations can upload up to 50 certificates. Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe certificate content in PEM format
namestringNoAn optional name for the certificate

openai_admin_usage_audio_speeches

Get audio speeches usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
user_idsstring[]NoReturn only usage for these users.
api_key_idsstring[]NoReturn only usage for these API keys.
modelsstring[]NoReturn only usage for these models.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_audio_transcriptions

Get audio transcriptions usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
user_idsstring[]NoReturn only usage for these users.
api_key_idsstring[]NoReturn only usage for these API keys.
modelsstring[]NoReturn only usage for these models.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_code_interpreter_sessions

Get code interpreter sessions usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_completions

Get completions usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
user_idsstring[]NoReturn only usage for these users.
api_key_idsstring[]NoReturn only usage for these API keys.
modelsstring[]NoReturn only usage for these models.
batchbooleanNoIf true, return batch jobs only. If false, return non-batch jobs only. By default, return both.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, batch or any combination of them.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_costs

Get costs details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently only 1d is supported, default to 1d.
project_idsstring[]NoReturn only costs for these projects.
group_bystring[]NoGroup the costs by the specified fields. Support fields include project_id, line_item and any combination of them.
limitintegerNoA limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_embeddings

Get embeddings usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
user_idsstring[]NoReturn only usage for these users.
api_key_idsstring[]NoReturn only usage for these API keys.
modelsstring[]NoReturn only usage for these models.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_images

Get images usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
sourcesstring[]NoReturn only usages for these sources. Possible values are image.generation, image.edit, image.variation or any combination of them.
sizesstring[]NoReturn only usages for these image sizes. Possible values are 256x256, 512x512, 1024x1024, 1792x1792, 1024x1792 or any combination of them.
project_idsstring[]NoReturn only usage for these projects.
user_idsstring[]NoReturn only usage for these users.
api_key_idsstring[]NoReturn only usage for these API keys.
modelsstring[]NoReturn only usage for these models.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, size, source or any combination of them.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_moderations

Get moderations usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
user_idsstring[]NoReturn only usage for these users.
api_key_idsstring[]NoReturn only usage for these API keys.
modelsstring[]NoReturn only usage for these models.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.

openai_admin_usage_vector_stores

Get vector stores usage details for the organization. Parameters:
ParameterTypeRequiredDefaultDescription
start_timeintegerYesStart time (Unix seconds) of the query time range, inclusive.
end_timeintegerNoEnd time (Unix seconds) of the query time range, exclusive.
bucket_widthstringNoWidth of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
project_idsstring[]NoReturn only usage for these projects.
group_bystring[]NoGroup the usage data by the specified fields. Support fields include project_id.
limitintegerNoSpecifies 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
pagestringNoA cursor for use in pagination. Corresponding to the next_page field from the previous response.