Skip to content

Commit ba922c9

Browse files
kodjomileskodjomiles
committed
Update Claude integration documentation to reflect name change and enhance clarity
- Renamed "Claude" to "Claude AI" in both JSON category file and markdown documentation. - Updated descriptions and titles throughout the documentation to include "AI" for consistency. - Added new integration entry for Claude AI in the integrations data file.
1 parent f1e6e45 commit ba922c9

File tree

5 files changed

+82
-31
lines changed

5 files changed

+82
-31
lines changed

‎docs/build-your-software-catalog/sync-data-to-catalog/ai-agents/claude/_category_.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Claude",
3-
"position": 2
2+
"label": "Claude AI",
3+
"position": 3
44
}
55

‎docs/build-your-software-catalog/sync-data-to-catalog/ai-agents/claude/claude.md‎

Lines changed: 70 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ import Prerequisites from "/docs/build-your-software-catalog/sync-data-to-catalo
44
import AdvancedConfig from '/docs/generalTemplates/_ocean_advanced_configuration_note.md'
55
import PortApiRegionTip from "/docs/generalTemplates/_port_region_parameter_explanation_template.md"
66

7-
# Claude
7+
# Claude AI
88

9-
Port's Claude integration allows you to ingest Claude API usage metrics into your software catalog using the [Ocean Custom Integration](/build-your-software-catalog/custom-integration/ocean-custom-integration/overview) framework.
9+
Port's Claude AI integration allows you to ingest Claude API usage metrics into your software catalog using the [Ocean Custom Integration](/build-your-software-catalog/custom-integration/ocean-custom-integration/overview) framework. After installing the integration, you can create dashboards to monitor API usage, track costs, analyze model performance, and measure workspace-level metrics using Port's dashboard widgets.
1010

1111
<img src="/img/ai-agents/claudeDashboard.png" border="1px" width="100%" />
1212

1313

1414
## Supported metrics
1515

16-
The Claude integration can ingest usage metrics from the Anthropic Admin API into Port:
16+
The Claude AI integration can ingest usage metrics from the Anthropic Admin API into Port:
1717

18-
**Available for all Claude organizations:**
18+
**Available for all Claude AI organizations:**
1919
- `claude_usage_record` - Organization-level usage metrics from `/v1/organizations/usage_report/messages` including token consumption (input/output/cache), request counts, and detailed breakdowns by workspace, model, service tier, context window, and API key.
2020
- `claude_cost_record` - Cost tracking from `/v1/organizations/cost_report` for monitoring organizational spending.
2121
- `claude_workspace_usage` - Workspace-level usage metrics when grouping by `workspace_id`.
2222
- `claude_model_usage` - Model-level usage metrics when grouping by `model`.
23-
- `claude_code_analytics` - Claude Code usage metrics from `/v1/organizations/usage_report/claude_code` including sessions, lines of code edited, commits, and pull requests (requires Claude Code access).
23+
- `claude_code_analytics` - Claude AI Code usage metrics from `/v1/organizations/usage_report/claude_code` including sessions, lines of code edited, commits, and pull requests (requires Claude AI Code access).
2424

2525
:::info User-level metrics
26-
The Anthropic Admin API does not currently support grouping usage data by user (`user_id`). User-level analytics are not available through these endpoints. If you need user-level insights, consider using Claude Code analytics or other internal telemetry sources.
26+
The Anthropic Admin API does not currently support grouping usage data by user (`user_id`). User-level analytics are not available through these endpoints. If you need user-level insights, consider using Claude AI Code analytics or other internal telemetry sources.
2727
:::
2828

2929

@@ -147,15 +147,15 @@ Before the integration can sync data, you need to create the required blueprints
147147
3. Copy and paste each blueprint JSON from the sections below.
148148

149149
<details>
150-
<summary><b>Claude Usage Record Blueprint (Click to expand)</b></summary>
150+
<summary><b>Claude AI Usage Record Blueprint (Click to expand)</b></summary>
151151

152152
Organization-level daily usage metrics:
153153

154154
```json showLineNumbers
155155
{
156156
"identifier": "claude_usage_record",
157-
"description": "A daily summary record of Claude API usage for an organization",
158-
"title": "Claude Usage Record",
157+
"description": "A daily summary record of Claude AI API usage for an organization",
158+
"title": "Claude AI Usage Record",
159159
"icon": "Anthropic",
160160
"schema": {
161161
"properties": {
@@ -249,15 +249,15 @@ Before the integration can sync data, you need to create the required blueprints
249249
</details>
250250

251251
<details>
252-
<summary><b>Claude Cost Record Blueprint (Click to expand)</b></summary>
252+
<summary><b>Claude AI Cost Record Blueprint (Click to expand)</b></summary>
253253

254254
Cost tracking for organizational spending:
255255

256256
```json showLineNumbers
257257
{
258258
"identifier": "claude_cost_record",
259259
"description": "Daily cost tracking for Claude API usage",
260-
"title": "Claude Cost Record",
260+
"title": "Claude AI Cost Record",
261261
"icon": "Anthropic",
262262
"schema": {
263263
"properties": {
@@ -298,15 +298,15 @@ Before the integration can sync data, you need to create the required blueprints
298298
</details>
299299

300300
<details>
301-
<summary><b>Claude Workspace Usage Blueprint (Click to expand)</b></summary>
301+
<summary><b>Claude AI Workspace Usage Blueprint (Click to expand)</b></summary>
302302

303303
Workspace-level usage metrics:
304304

305305
```json showLineNumbers
306306
{
307307
"identifier": "claude_workspace_usage",
308308
"description": "Usage metrics broken down by workspace",
309-
"title": "Claude Workspace Usage",
309+
"title": "Claude AI Workspace Usage",
310310
"icon": "Anthropic",
311311
"schema": {
312312
"properties": {
@@ -394,15 +394,15 @@ Before the integration can sync data, you need to create the required blueprints
394394
</details>
395395

396396
<details>
397-
<summary><b>Claude Model Usage Blueprint (Click to expand)</b></summary>
397+
<summary><b>Claude AI Model Usage Blueprint (Click to expand)</b></summary>
398398

399399
Model-level usage statistics:
400400

401401
```json showLineNumbers
402402
{
403403
"identifier": "claude_model_usage",
404404
"description": "Usage metrics broken down by Claude model type",
405-
"title": "Claude Model Usage",
405+
"title": "Claude AI Model Usage",
406406
"icon": "Anthropic",
407407
"schema": {
408408
"properties": {
@@ -495,15 +495,15 @@ Before the integration can sync data, you need to create the required blueprints
495495
</details>
496496

497497
<details>
498-
<summary><b>Claude Code analytics Blueprint (Click to expand)</b></summary>
498+
<summary><b>Claude AI Code analytics Blueprint (Click to expand)</b></summary>
499499

500500
Claude Code usage metrics for tracking development activity:
501501

502502
```json showLineNumbers
503503
{
504504
"identifier": "claude_code_analytics",
505505
"description": "Daily Claude Code usage metrics including sessions, lines of code, commits, and PRs",
506-
"title": "Claude Code Analytics",
506+
"title": "Claude AI Code Analytics",
507507
"icon": "Anthropic",
508508
"schema": {
509509
"properties": {
@@ -598,7 +598,7 @@ You can set headers from the Ocean integration UI (Advanced settings → Headers
598598

599599
1. Go to your [data sources page](https://app.getport.io/settings/data-sources).
600600

601-
2. Find your Claude integration in the list.
601+
2. Find your Claude AI integration in the list.
602602

603603
3. Click on the integration to open the mapping editor.
604604

@@ -760,7 +760,7 @@ You can set headers from the Ocean integration UI (Advanced settings → Headers
760760
<details>
761761
<summary><b>Claude Code analytics mapping (Click to expand)</b></summary>
762762

763-
Track Claude Code usage metrics including sessions, lines of code, commits, and pull requests:
763+
Track Claude AI Code usage metrics including sessions, lines of code, commits, and pull requests:
764764

765765
:::info Requires Claude Code access
766766
This endpoint requires access to Claude Code. You'll receive an error if your organization doesn't have Claude Code enabled.
@@ -839,7 +839,10 @@ You now have a blank dashboard where you can add widgets to visualize your Claud
839839

840840
Create the following widgets to gain insights into your Claude API usage:
841841

842-
<h3>Total API Requests</h3>
842+
<h4>Total API Requests</h4>
843+
844+
<details>
845+
<summary><b>Total API Requests (click to expand)</b></summary>
843846

844847
1. Click on **`+ Widget`** and select **Number Chart**.
845848

@@ -859,8 +862,12 @@ Create the following widgets to gain insights into your Claude API usage:
859862
- **Function**: `Sum`.
860863

861864
3. Click **Save**.
865+
</details>
866+
867+
<h4>Total Cost</h4>
862868

863-
<h3>Total Cost</h3>
869+
<details>
870+
<summary><b>Total Cost (click to expand)</b></summary>
864871

865872
1. Click on **`+ Widget`** and select **Number Chart**.
866873

@@ -881,8 +888,12 @@ Create the following widgets to gain insights into your Claude API usage:
881888
- **Function**: `Sum`.
882889

883890
3. Click **Save**.
891+
</details>
884892

885-
<h3>API Success Rate</h3>
893+
<h4>API Success Rate</h4>
894+
895+
<details>
896+
<summary><b>API Success Rate (click to expand)</b></summary>
886897

887898
1. Click on **`+ Widget`** and select **Number Chart**.
888899

@@ -901,8 +912,12 @@ Create the following widgets to gain insights into your Claude API usage:
901912
- **Function**: `Average`.
902913

903914
3. Click **Save**.
915+
</details>
916+
917+
<h4>Token Usage Over Time</h4>
904918

905-
<h3>Token Usage Over Time</h3>
919+
<details>
920+
<summary><b>Token Usage Over Time (click to expand)</b></summary>
906921

907922
1. Click on **`+ Widget`** and select **Line Chart**.
908923

@@ -930,7 +945,12 @@ Create the following widgets to gain insights into your Claude API usage:
930945

931946
3. Click **Save**.
932947

933-
<h3>Daily Cost Trends</h3>
948+
</details>
949+
950+
<h4>Daily Cost Trends</h4>
951+
952+
<details>
953+
<summary><b>Daily Cost Trends (click to expand)</b></summary>
934954

935955
1. Click on **`+ Widget`** and select **Line Chart**.
936956

@@ -958,7 +978,12 @@ Create the following widgets to gain insights into your Claude API usage:
958978

959979
3. Click **Save**.
960980

961-
<h3>Model Usage Distribution</h3>
981+
</details>
982+
983+
<h4>Model Usage Distribution</h4>
984+
985+
<details>
986+
<summary><b>Model Usage Distribution (click to expand)</b></summary>
962987

963988
1. Click on **`+ Widget`** and select **Pie Chart**.
964989

@@ -976,7 +1001,12 @@ Create the following widgets to gain insights into your Claude API usage:
9761001

9771002
3. Click **Save**.
9781003

979-
<h3>Request Success vs Failure Rate</h3>
1004+
</details>
1005+
1006+
<h4>Request Success vs Failure Rate</h4>
1007+
1008+
<details>
1009+
<summary><b>Request Success vs Failure Rate (click to expand)</b></summary>
9801010

9811011
1. Click on **`+ Widget`** and select **Line Chart**.
9821012

@@ -1004,7 +1034,12 @@ Create the following widgets to gain insights into your Claude API usage:
10041034

10051035
3. Click **Save**.
10061036

1007-
<h3>Claude Code Activity</h3>
1037+
</details>
1038+
1039+
<h4>Claude Code Activity</h4>
1040+
1041+
<details>
1042+
<summary><b>Claude Code Activity (click to expand)</b></summary>
10081043

10091044
1. Click on **`+ Widget`** and select **Line Chart**.
10101045

@@ -1032,7 +1067,12 @@ Create the following widgets to gain insights into your Claude API usage:
10321067

10331068
3. Click **Save**.
10341069

1035-
<h3>Cache Efficiency</h3>
1070+
</details>
1071+
1072+
<h4>Cache Efficiency</h4>
1073+
1074+
<details>
1075+
<summary><b>Cache Efficiency (click to expand)</b></summary>
10361076

10371077
1. Click on **`+ Widget`** and select **Line Chart**.
10381078

@@ -1060,3 +1100,5 @@ Create the following widgets to gain insights into your Claude API usage:
10601100

10611101
3. Click **Save**.
10621102

1103+
</details>
1104+

‎src/components/IntegrationsTable/integrations-data.js‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,14 @@ export const integrations = [
238238
icon: '/img/guides/icons/GithubCopilot.svg',
239239
darkIcon: '/img/guides/icons/dark/GithubCopilot.svg',
240240
docsUrl: '/build-your-software-catalog/sync-data-to-catalog/ai-agents/github-copilot',
241-
}
241+
},
242+
{
243+
name: 'Claude AI',
244+
category: 'ai-agents',
245+
icon: '/img/guides/icons/ClaudeAI.svg',
246+
darkIcon: '/img/guides/icons/dark/ClaudeAI.svg',
247+
docsUrl: '/build-your-software-catalog/sync-data-to-catalog/ai-agents/claude',
248+
},
242249
];
243250

244251
export const categories = {

‎static/img/guides/icons/ClaudeAI.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎static/img/guides/icons/dark/ClaudeAI.svg‎

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)