feat(api): add proj analytics endpoint

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 42
+configured_endpoints: 43
 openapi_spec_hash: 62b629dd5b215c1eebc57e0c6039eea7
-config_hash: 2d88a0a41f5faca603ff2789a116d988
+config_hash: 5e459b33c53ffa6e554087a779bdb790

api.md

@@ -141,6 +141,7 @@ from codex.types import (
     ProjectListResponse,
     ProjectExportResponse,
     ProjectIncrementQueriesResponse,
+    ProjectRetrieveAnalyticsResponse,
 )
 ```
 
@@ -153,6 +154,7 @@ Methods:
 - <code title="delete /api/projects/{project_id}">client.projects.<a href="./src/codex/resources/projects/projects.py">delete</a>(project_id) -> None</code>
 - <code title="get /api/projects/{project_id}/export">client.projects.<a href="./src/codex/resources/projects/projects.py">export</a>(project_id) -> <a href="./src/codex/types/project_export_response.py">object</a></code>
 - <code title="post /api/projects/{project_id}/increment_queries">client.projects.<a href="./src/codex/resources/projects/projects.py">increment_queries</a>(project_id) -> <a href="./src/codex/types/project_increment_queries_response.py">object</a></code>
+- <code title="get /api/projects/{project_id}/analytics/">client.projects.<a href="./src/codex/resources/projects/projects.py">retrieve_analytics</a>(project_id, \*\*<a href="src/codex/types/project_retrieve_analytics_params.py">params</a>) -> <a href="./src/codex/types/project_retrieve_analytics_response.py">ProjectRetrieveAnalyticsResponse</a></code>
 
 ## AccessKeys
 

src/codex/resources/projects/projects.py

@@ -7,7 +7,12 @@
 
 import httpx
 
-from ...types import project_list_params, project_create_params, project_update_params
+from ...types import (
+    project_list_params,
+    project_create_params,
+    project_update_params,
+    project_retrieve_analytics_params,
+)
 from .entries import (
     EntriesResource,
     AsyncEntriesResource,
@@ -46,6 +51,7 @@
 from ...types.project_list_response import ProjectListResponse
 from ...types.project_return_schema import ProjectReturnSchema
 from ...types.project_retrieve_response import ProjectRetrieveResponse
+from ...types.project_retrieve_analytics_response import ProjectRetrieveAnalyticsResponse
 
 __all__ = ["ProjectsResource", "AsyncProjectsResource"]
 
@@ -354,6 +360,59 @@ def increment_queries(
             cast_to=object,
         )
 
+    def retrieve_analytics(
+        self,
+        project_id: str,
+        *,
+        end: int | NotGiven = NOT_GIVEN,
+        sme_limit: int | NotGiven = NOT_GIVEN,
+        start: int | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> ProjectRetrieveAnalyticsResponse:
+        """
+        Get Project Analytics Route
+
+        Args:
+          end: End timestamp in seconds since epoch
+
+          sme_limit: Limit the number of top SME contributors to return.
+
+          start: Start timestamp in seconds since epoch
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not project_id:
+            raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
+        return self._get(
+            f"/api/projects/{project_id}/analytics/",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "end": end,
+                        "sme_limit": sme_limit,
+                        "start": start,
+                    },
+                    project_retrieve_analytics_params.ProjectRetrieveAnalyticsParams,
+                ),
+            ),
+            cast_to=ProjectRetrieveAnalyticsResponse,
+        )
+
 
 class AsyncProjectsResource(AsyncAPIResource):
     @cached_property
@@ -659,6 +718,59 @@ async def increment_queries(
             cast_to=object,
         )
 
+    async def retrieve_analytics(
+        self,
+        project_id: str,
+        *,
+        end: int | NotGiven = NOT_GIVEN,
+        sme_limit: int | NotGiven = NOT_GIVEN,
+        start: int | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> ProjectRetrieveAnalyticsResponse:
+        """
+        Get Project Analytics Route
+
+        Args:
+          end: End timestamp in seconds since epoch
+
+          sme_limit: Limit the number of top SME contributors to return.
+
+          start: Start timestamp in seconds since epoch
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not project_id:
+            raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
+        return await self._get(
+            f"/api/projects/{project_id}/analytics/",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "end": end,
+                        "sme_limit": sme_limit,
+                        "start": start,
+                    },
+                    project_retrieve_analytics_params.ProjectRetrieveAnalyticsParams,
+                ),
+            ),
+            cast_to=ProjectRetrieveAnalyticsResponse,
+        )
+
 
 class ProjectsResourceWithRawResponse:
     def __init__(self, projects: ProjectsResource) -> None:
@@ -685,6 +797,9 @@ def __init__(self, projects: ProjectsResource) -> None:
         self.increment_queries = to_raw_response_wrapper(
             projects.increment_queries,
         )
+        self.retrieve_analytics = to_raw_response_wrapper(
+            projects.retrieve_analytics,
+        )
 
     @cached_property
     def access_keys(self) -> AccessKeysResourceWithRawResponse:
@@ -724,6 +839,9 @@ def __init__(self, projects: AsyncProjectsResource) -> None:
         self.increment_queries = async_to_raw_response_wrapper(
             projects.increment_queries,
         )
+        self.retrieve_analytics = async_to_raw_response_wrapper(
+            projects.retrieve_analytics,
+        )
 
     @cached_property
     def access_keys(self) -> AsyncAccessKeysResourceWithRawResponse:
@@ -763,6 +881,9 @@ def __init__(self, projects: ProjectsResource) -> None:
         self.increment_queries = to_streamed_response_wrapper(
             projects.increment_queries,
         )
+        self.retrieve_analytics = to_streamed_response_wrapper(
+            projects.retrieve_analytics,
+        )
 
     @cached_property
     def access_keys(self) -> AccessKeysResourceWithStreamingResponse:
@@ -802,6 +923,9 @@ def __init__(self, projects: AsyncProjectsResource) -> None:
         self.increment_queries = async_to_streamed_response_wrapper(
             projects.increment_queries,
         )
+        self.retrieve_analytics = async_to_streamed_response_wrapper(
+            projects.retrieve_analytics,
+        )
 
     @cached_property
     def access_keys(self) -> AsyncAccessKeysResourceWithStreamingResponse:

src/codex/types/__init__.py

@@ -15,7 +15,9 @@
 from .project_retrieve_response import ProjectRetrieveResponse as ProjectRetrieveResponse
 from .organization_schema_public import OrganizationSchemaPublic as OrganizationSchemaPublic
 from .user_activate_account_params import UserActivateAccountParams as UserActivateAccountParams
+from .project_retrieve_analytics_params import ProjectRetrieveAnalyticsParams as ProjectRetrieveAnalyticsParams
 from .organization_list_members_response import OrganizationListMembersResponse as OrganizationListMembersResponse
+from .project_retrieve_analytics_response import ProjectRetrieveAnalyticsResponse as ProjectRetrieveAnalyticsResponse
 from .organization_retrieve_permissions_response import (
     OrganizationRetrievePermissionsResponse as OrganizationRetrievePermissionsResponse,
 )

src/codex/types/project_retrieve_analytics_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ProjectRetrieveAnalyticsParams"]
+
+
+class ProjectRetrieveAnalyticsParams(TypedDict, total=False):
+    end: int
+    """End timestamp in seconds since epoch"""
+
+    sme_limit: int
+    """Limit the number of top SME contributors to return."""
+
+    start: int
+    """Start timestamp in seconds since epoch"""

src/codex/types/project_retrieve_analytics_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List
+
+from .._models import BaseModel
+
+__all__ = [
+    "ProjectRetrieveAnalyticsResponse",
+    "AnswersPublished",
+    "AnswersPublishedAnswersByAuthor",
+    "BadResponses",
+    "Queries",
+]
+
+
+class AnswersPublishedAnswersByAuthor(BaseModel):
+    answers_published: int
+
+    name: str
+
+    user_id: str
+
+
+class AnswersPublished(BaseModel):
+    answers_by_author: List[AnswersPublishedAnswersByAuthor]
+
+
+class BadResponses(BaseModel):
+    responses_by_type: Dict[str, int]
+
+    total: int
+
+
+class Queries(BaseModel):
+    total: int
+
+
+class ProjectRetrieveAnalyticsResponse(BaseModel):
+    answers_published: AnswersPublished
+
+    bad_responses: BadResponses
+
+    queries: Queries