Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportResponseContent(
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="request"></param>
Expand Down Expand Up @@ -94,7 +98,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportResponseContent(
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="request"></param>
Expand Down Expand Up @@ -570,7 +578,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportResponseContent(
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="startDate">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportAsStreamResponse(
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="request"></param>
Expand Down Expand Up @@ -414,7 +418,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportAsStreamResponse(
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="startDate">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ public partial interface IAnalyticsClient
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="request"></param>
Expand All @@ -31,7 +35,11 @@ public partial interface IAnalyticsClient
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="request"></param>
Expand All @@ -51,7 +59,11 @@ public partial interface IAnalyticsClient
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="startDate">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ public partial interface IAnalyticsClient
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="request"></param>
Expand All @@ -31,7 +35,11 @@ public partial interface IAnalyticsClient
/// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).<br/>
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range<br/>
/// or apply filters to reduce the number of rows if you encounter a timeout.<br/>
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
/// Results are streamed, if an error occurs, an error message is appended and the stream is closed.<br/>
/// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and<br/>
/// must be allowed to read the analytics of every group listed. The rows then cover the messages of<br/>
/// the users who were members of those groups when the message was sent, and the `userGroupIds`<br/>
/// and `userGroupNames` columns only list the requested groups.
/// </summary>
/// <param name="wId"></param>
/// <param name="startDate">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ public sealed partial class CreateWAnalyticsConsumptionExportRequestFilter
public global::System.Collections.Generic.IList<string>? ApiKeys { get; set; }

/// <summary>
/// Group IDs to filter on
/// Group IDs to filter on. Required, with at least one non-empty value, unless the<br/>
/// API key has admin scope.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("groups")]
public global::System.Collections.Generic.IList<string>? Groups { get; set; }
Expand Down Expand Up @@ -82,7 +83,8 @@ public sealed partial class CreateWAnalyticsConsumptionExportRequestFilter
/// API key names to filter on
/// </param>
/// <param name="groups">
/// Group IDs to filter on
/// Group IDs to filter on. Required, with at least one non-empty value, unless the<br/>
/// API key has admin scope.
/// </param>
/// <param name="models">
/// Model IDs to filter on
Expand Down
6 changes: 3 additions & 3 deletions src/libs/Dust/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
"/api/v1/w/{wId}/analytics/consumption/export": {
"post": {
"summary": "Export consumption analytics",
"description": "Export per-call consumption analytics for the workspace identified by {wId}.\nEach row represents one unit of billed credit consumption (an LLM call or a tool call).\nThe export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).\nThe export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range\nor apply filters to reduce the number of rows if you encounter a timeout.\nResults are streamed, if an error occurs, an error message is appended and the stream is closed.\n",
"description": "Export per-call consumption analytics for the workspace identified by {wId}.\nEach row represents one unit of billed credit consumption (an LLM call or a tool call).\nThe export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).\nThe export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range\nor apply filters to reduce the number of rows if you encounter a timeout.\nResults are streamed, if an error occurs, an error message is appended and the stream is closed.\n\nAn admin API key can export the whole workspace. Any other API key must filter on `groups`, and\nmust be allowed to read the analytics of every group listed. The rows then cover the messages of\nthe users who were members of those groups when the message was sent, and the `userGroupIds`\nand `userGroupNames` columns only list the requested groups.\n",
"tags": [
"Analytics"
],
Expand Down Expand Up @@ -218,7 +218,7 @@
"type": "string",
"maxLength": 256
},
"description": "Group IDs to filter on"
"description": "Group IDs to filter on. Required, with at least one non-empty value, unless the\nAPI key has admin scope.\n"
},
"models": {
"type": "array",
Expand Down Expand Up @@ -288,7 +288,7 @@
"description": "Invalid request body (missing fields, invalid dates, range exceeds 30 days)"
},
"403": {
"description": "Requires an API key with admin scope"
"description": "The workspace does not have access to the consumption export API, or the API key has no\nadmin scope and the export is not restricted to groups whose analytics it can read.\n"
},
"500": {
"description": "Internal Server Error"
Expand Down
Loading