Skip to content

docs(api): get spans #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(api): get spans #82

wants to merge 1 commit into from

Conversation

nirga
Copy link
Member

@nirga nirga commented May 20, 2025

Important

Adds documentation for the GET /api/v2/warehouse/spans API endpoint and updates navigation to include this new page.

  • Documentation:
    • Adds get_spans.mdx to document the GET /api/v2/warehouse/spans API endpoint.
    • Describes request parameters: from_timestamp, limit, cursor, workflow.
    • Describes response fields: data, page_size, total_results, next_cursor.
  • Navigation:
    • Updates mint.json to include the new "Get Spans" page under the "Data Warehouse" group.

This description was created by Ellipsis for d8ef129. You can customize this summary. It will automatically update as commits are pushed.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Caution

Changes requested ❌

Reviewed everything up to d8ef129 in 1 minute and 38 seconds. Click for details.
  • Reviewed 75 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. api-reference/dwh/get_spans.mdx:27
  • Draft comment:
    Consider adding an example response or request example to improve clarity for API consumers.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
2. mint.json:169
  • Draft comment:
    New 'Data Warehouse' group added. Confirm that its placement and ordering in navigation is intentional.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None

Workflow ID: wflow_cZAQuEdIRiSZK7jM

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Maximum number of results to return. Default is 50, maximum is 1000.
</ParamField>

<ParamField query="cursor" type="int">
Copy link

Choose a reason for hiding this comment

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

Inconsistent types: cursor is defined as int but next_cursor in the response is a string. Clarify if this conversion is intentional.

@@ -0,0 +1,43 @@
---
title: "Get Spans"
api: "GET https://api.traceloop.com/api/v2/warehouse/spans"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
api: "GET https://api.traceloop.com/api/v2/warehouse/spans"
api: "GET https://api.traceloop.com/v2/warehouse/spans"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants