Add docs agents and llms docs for insight #5881

AmineAfia · 2025-01-03T17:51:01Z

title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

How to test

Unit tests, playground, etc.

PR-Codex overview

This PR introduces documentation for the thirdweb Insight API, specifically targeting usage for agents and LLMs. It provides metadata, API usage instructions, core concepts, response structures, examples, query parameters, and error handling.

Detailed summary

Added metadata for the page with title and description.
Included API URL and authentication methods.
Defined core concepts like Chain IDs and Base Response Structure.
Provided examples for Events API, Token Balance API, and complex filtering.
Described error handling and common query parameters.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

vercel · 2025-01-03T17:51:04Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 11:58pm

3 Skipped Deployments

Name	Status	Updated (UTC)
thirdweb_playground	⬜️ Skipped (Inspect)	Jan 3, 2025 11:58pm
thirdweb-www	⬜️ Skipped (Inspect)	Jan 3, 2025 11:58pm
wallet-ui	⬜️ Skipped (Inspect)	Jan 3, 2025 11:58pm

changeset-bot · 2025-01-03T17:51:07Z

⚠️ No Changeset found

Latest commit: 6bf217e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

AmineAfia · 2025-01-03T17:51:16Z

Add docs agents and llms docs for insight #5881 👈 (View in Graphite)
main

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

merge-queue - adds this PR to the back of the merge queue
hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

apps/portal/src/app/insight/agents-and-llms/page.mdx

codecov · 2025-01-03T17:52:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.19%. Comparing base (20a2b3b) to head (fc66060).
Report is 7 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5881   +/-   ##
=======================================
  Coverage   55.19%   55.19%           
=======================================
  Files        1123     1123           
  Lines       59622    59617    -5     
  Branches     5029     5027    -2     
=======================================
- Hits        32906    32905    -1     
+ Misses      25996    25992    -4     
  Partials      720      720

Flag	Coverage Δ		*Carryforward flag
legacy_packages	`65.68% <ø> (ø)`		Carriedforward from 20a2b3b
packages	`52.85% <ø> (+<0.01%)`	⬆️

*This pull request uses carry forward flags. Click here to find out more.

see 3 files with indirect coverage changes

graphite-app · 2025-01-03T17:54:02Z

apps/portal/src/app/insight/agents-and-llms/page.mdx

+1. **Get All Transactions**
+
+```typescript
+GET / v1 / transactions;


There appears to be extra whitespace in the endpoint path GET / v1 / transactions;. The correct format should be GET /v1/transactions

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

github-actions · 2025-01-03T17:56:55Z

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
thirdweb (esm)	45 KB (0%)	900 ms (0%)	3 s (-12.44% 🔽)	3.9 s
thirdweb (cjs)	110.81 KB (0%)	2.3 s (0%)	6.2 s (-20.36% 🔽)	8.4 s
thirdweb (minimal + tree-shaking)	5.58 KB (0%)	112 ms (0%)	459 ms (+37.04% 🔺)	571 ms
thirdweb/chains (tree-shaking)	506 B (0%)	10 ms (0%)	206 ms (+114.62% 🔺)	216 ms
thirdweb/react (minimal + tree-shaking)	19.13 KB (0%)	383 ms (0%)	619 ms (-6.66% 🔽)	1.1 s

gregfromstl · 2025-01-03T22:07:50Z

Merge activity

Jan 3, 5:07 PM EST: The merge label 'merge-queue' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Jan 3, 5:43 PM EST: A user added this pull request to the Graphite merge queue.
Jan 3, 6:38 PM EST: The Graphite merge queue couldn't merge this PR because it was not satisfying all requirements (Failed CI: 'Vercel – docs-v2').
Jan 3, 7:08 PM EST: The merge label 'merge-queue' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Jan 3, 7:08 PM EST: A user added this pull request to the Graphite merge queue.
Jan 3, 7:08 PM EST: A user merged this pull request with the Graphite merge queue.

--- title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes" --- If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000): ## Notes for the reviewer Anything important to call out? Be sure to also clarify these in your comments. ## How to test Unit tests, playground, etc.  --- ## PR-Codex overview This PR introduces documentation for the `thirdweb Insight` API, targeting agents and LLMs. It includes usage instructions, core concepts, API examples, query parameters, and error handling. ### Detailed summary - Added metadata for the page with title and description. - Provided API usage instructions for agents and LLMs. - Explained authentication methods (header, query parameter, bearer token). - Detailed core concepts including chain IDs and base response structure. - Included examples for Events API, Token Balance API, and filtering. - Documented API reference for Events and Transactions. - Listed common query parameters and filter types. - Explained error handling for API responses. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

vercel bot temporarily deployed to Preview – thirdweb_playground January 3, 2025 17:51 Inactive

vercel bot temporarily deployed to Preview – wallet-ui January 3, 2025 17:51 Inactive

vercel bot temporarily deployed to Preview – thirdweb-www January 3, 2025 17:51 Inactive

github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Jan 3, 2025

github-actions bot assigned AmineAfia Jan 3, 2025

AmineAfia requested a review from ianthirdweb January 3, 2025 17:51

AmineAfia marked this pull request as ready for review January 3, 2025 17:51

AmineAfia requested review from jakubkrehel and a team as code owners January 3, 2025 17:51

graphite-app bot reviewed Jan 3, 2025

View reviewed changes

apps/portal/src/app/insight/agents-and-llms/page.mdx Outdated Show resolved Hide resolved

vercel bot temporarily deployed to Preview – thirdweb-www January 3, 2025 17:53 Inactive

vercel bot temporarily deployed to Preview – wallet-ui January 3, 2025 17:53 Inactive

vercel bot temporarily deployed to Preview – thirdweb_playground January 3, 2025 17:53 Inactive

graphite-app bot reviewed Jan 3, 2025

View reviewed changes

vercel bot deployed to Preview – docs-v2 January 3, 2025 18:06 View deployment

edwardysun approved these changes Jan 3, 2025

View reviewed changes

gregfromstl added the merge-queue Adds the pull request to Graphite's merge queue. label Jan 3, 2025

gregfromstl approved these changes Jan 3, 2025

View reviewed changes

gregfromstl force-pushed the 01-03-add_docs_agents_and_llms_docs_for_insight branch from 6bf217e to fc66060 Compare January 3, 2025 22:51

vercel bot temporarily deployed to Preview – thirdweb_playground January 3, 2025 22:51 Inactive

vercel bot temporarily deployed to Preview – thirdweb-www January 3, 2025 22:51 Inactive

vercel bot temporarily deployed to Preview – wallet-ui January 3, 2025 22:51 Inactive

vercel bot deployed to Preview – docs-v2 January 3, 2025 23:38 View deployment

graphite-app bot removed the merge-queue Adds the pull request to Graphite's merge queue. label Jan 3, 2025

gregfromstl added the merge-queue Adds the pull request to Graphite's merge queue. label Jan 4, 2025

graphite-app bot merged commit fc66060 into main Jan 4, 2025
32 checks passed

graphite-app bot deleted the 01-03-add_docs_agents_and_llms_docs_for_insight branch January 4, 2025 00:08

vercel bot temporarily deployed to Production – thirdweb-www January 4, 2025 00:08 Inactive

vercel bot temporarily deployed to Production – wallet-ui January 4, 2025 00:08 Inactive

vercel bot temporarily deployed to Production – thirdweb_playground January 4, 2025 00:08 Inactive

vercel bot deployed to Production – docs-v2 January 4, 2025 00:10 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add docs agents and llms docs for insight #5881

Add docs agents and llms docs for insight #5881

Uh oh!

AmineAfia commented Jan 3, 2025 •

edited by pr-codex bot

Loading

Uh oh!

vercel bot commented Jan 3, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Jan 3, 2025 •

edited

Loading

Uh oh!

AmineAfia commented Jan 3, 2025

Uh oh!

Uh oh!

codecov bot commented Jan 3, 2025 •

edited

Loading

Uh oh!

graphite-app bot Jan 3, 2025

Uh oh!

github-actions bot commented Jan 3, 2025 •

edited

Loading

Uh oh!

gregfromstl commented Jan 3, 2025 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Uh oh!

Add docs agents and llms docs for insight #5881

Add docs agents and llms docs for insight #5881

Uh oh!

Conversation

AmineAfia commented Jan 3, 2025 • edited by pr-codex bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

Notes for the reviewer

How to test

PR-Codex overview

Detailed summary

Uh oh!

vercel bot commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

AmineAfia commented Jan 3, 2025

How to use the Graphite Merge Queue

Uh oh!

Uh oh!

codecov bot commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

graphite-app bot Jan 3, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

gregfromstl commented Jan 3, 2025 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Uh oh!

AmineAfia commented Jan 3, 2025 •

edited by pr-codex bot

Loading

vercel bot commented Jan 3, 2025 •

edited

Loading

changeset-bot bot commented Jan 3, 2025 •

edited

Loading

codecov bot commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

gregfromstl commented Jan 3, 2025 •

edited by graphite-app bot

Loading