Skip to content

docs: update metrics and observations reference links#3071

Open
boleg-dev wants to merge 1 commit into
langfuse:mainfrom
boleg-dev:update-docs
Open

docs: update metrics and observations reference links#3071
boleg-dev wants to merge 1 commit into
langfuse:mainfrom
boleg-dev:update-docs

Conversation

@boleg-dev

@boleg-dev boleg-dev commented Jun 8, 2026

Copy link
Copy Markdown

v2 api links are outdated. This PR updates deep links to current ones

Greptile Summary

This PR updates two stale API reference deep-links in the Langfuse docs, replacing the observationsv2 and metricsv2 URL tag fragments with their current counterparts (observations and metrics) so the callout boxes at the bottom of each page point to valid anchors in the API reference.

  • observations-api.mdx (line 245): updates #tag/observationsv2/GET/api/public/v2/observations#tag/observations/GET/api/public/v2/observations.
  • metrics-api.mdx (line 79): updates #tag/metricsv2/GET/api/public/v2/metrics#tag/metrics/GET/api/public/v2/metrics.
  • A second occurrence of the old observationsv2 link on line 48 of observations-api.mdx (inside the upgrade-path paragraph) was not updated and still points to the broken anchor.

Confidence Score: 4/5

Safe to merge after fixing the one missed link — both changed files are documentation only.

The PR correctly updates two callout-level links, but leaves a third stale observationsv2 URL on line 48 of observations-api.mdx untouched. That link is in the body of the upgrade-path section and will continue to send users to a broken anchor until fixed.

content/docs/api-and-data-platform/features/observations-api.mdx — the upgrade-path paragraph on line 48 still carries the old observationsv2 fragment.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[observations-api.mdx] -->|line 48 - MISSED| B["Old: #tag/observationsv2/GET/api/public/v2/observations"]
    A -->|line 245 - Updated| C["New: #tag/observations/GET/api/public/v2/observations"]
    D[metrics-api.mdx] -->|line 79 - Updated| E["New: #tag/metrics/GET/api/public/v2/metrics"]
    F["Old: #tag/metricsv2/GET/api/public/v2/metrics"] -->|replaced by| E
    B -->|should be replaced by| C
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
content/docs/api-and-data-platform/features/observations-api.mdx:48
This in-line reference still uses the old `observationsv2` tag, while the equivalent callout link at the bottom of the file is updated by this PR. Both should be consistent — users following this link from the upgrade-path section would land on a broken anchor.

```suggestion
The v2 Observations API returns observation rows, not full trace objects. Group rows by `traceId` when you need to reconstruct trace activity, and use [Metrics API v2](/docs/metrics/features/metrics-api#v2) for aggregate reporting with trace-level dimensions such as `traceName`, `traceRelease`, or `traceVersion`. For single-observation lookups, pass a URL-encoded `filter` condition on the `id` column; see the [v2 Observations API Reference](https://api.reference.langfuse.com/#tag/observations/GET/api/public/v2/observations) for the filter schema.
```

Reviews (1): Last reviewed commit: "docs: update metrics and observations re..." | Re-trigger Greptile

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@vercel

vercel Bot commented Jun 8, 2026

Copy link
Copy Markdown

@boleg-dev is attempting to deploy a commit to the langfuse Team on Vercel.

A member of the Team first needs to authorize it.

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jun 8, 2026
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@dosubot dosubot Bot added the docs label Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants