Retrieve all pipe reports for a specific pipe
Before You Begin
🔗 Use the GraphQL Playground to execute the queries in this guide.
➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.
Prerequisites
- Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
- Permissions: Ensure your token has the necessary permissions to access the pipe.
- Pipe UUID: Identify the Pipe you want to fetch reports for.
Step 1: Find The Pipe UUID
To execute this query, you’ll need the UUID of the pipe.
- Refer to our Get resource IDs page for guidance on retrieving UUIDs using GraphQL queries.
Step 2: Query Pipe Reports
Execute the pipeReports query to retrieve all reports of the pipe:
{
pipeReports(pipeUuid: "123456789") {
edges {
node {
id
name
cardCount
color
createdAt
lastUpdatedAt
fields
filter
sortBy {
field
direction
}
selectedFormulaFields {
indexName
}
repo {
id
name
}
}
}
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
}
}
Response Example
{
"data": {
"pipeReports": {
"edges": [
{
"node": {
"id": "456789123",
"name": "Sales Pipeline Report",
"cardCount": 1250,
"color": "#FF6B6B",
"createdAt": "2024-01-15T10:30:00Z",
"lastUpdatedAt": "2024-03-13T14:45:00Z",
"fields": ["title", "status", "assignee", "due_date"],
"filter": {
"status": ["in_progress", "review"]
},
"sortBy": {
"field": "due_date",
"direction": "ASC"
},
"selectedFormulaFields": [
{
"indexName": "field_1_number"
},
{
"indexName": "sum"
}
],
"repo": {
"id": "123456789",
"name": "Sales Pipeline"
}
}
},
{
"node": {
"id": "456789124",
"name": "Lead Management Report",
"cardCount": 89,
"color": "#4ECDC4",
"createdAt": "2024-02-20T09:15:00Z",
"lastUpdatedAt": "2024-03-12T16:20:00Z",
"fields": ["title", "lead_source", "value", "created_at"],
"filter": null,
"sortBy": {
"field": "created_at",
"direction": "desc"
},
"selectedFormulaFields": [
{
"indexName": "average"
}
],
"repo": {
"id": "123456789",
"name": "Sales Pipeline"
}
}
}
],
"pageInfo": {
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "YXJyYXljb25uZWN0aW9uOjA=",
"endCursor": "YXJyYXljb25uZWN0aW9uOjE="
}
}
}
}
Key Fields Explained
Report Information
id: Unique identifier for the reportname: Display name of the reportcardCount: Total number of cards included in the reportcolor: The report's color (enum values: red, blue, green, etc.)createdAt: Timestamp when the report was createdlastUpdatedAt: Timestamp when the report was last modified
Report Configuration
fields: Array of field names to display in the reportfilter: JSON object containing filter criteria applied to the reportsortBy: Object defining how cards are sorted in the reportfield: The field name to sort bydirection: Sort direction (ascordesc)
selectedFormulaFields: Array of formula fields included in the reportindexName: The formula field identifier
Associated Resources
repo: The pipe this report belongs toid: Pipe IDname: Pipe name
Pagination
The pipeReports query uses pagination. Refer to our Pagination basics page to understand more about how it works.
pageInfo: Pagination information for handling large result setshasNextPage: Boolean indicating if more results are availablehasPreviousPage: Boolean indicating if previous results existstartCursor: Cursor for the first item in the current pageendCursor: Cursor for the last item in the current page
Notes
- Pagination: The query supports pagination with a maximum page size of 500 items
- Pipe UUID: Use the pipe UUID (not ID) to query pipe reports