Retrieve a specific organization report by its ID
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 specific report.
- Report ID: Identify the Organization Report you want to fetch.
Step 1: Find The Report ID
-
Via Pipefy UI:
- Open the Organization Report in your browser.
- The URL will include the Report ID:
https://app.pipefy.com/organizations/123/reports/987654321
. - Report ID =
987654321
(the number after/reports/
).
-
Via GraphQL Query:
- Use the
organizationReports
query to list all reports and find the specific report ID you need. - How to get organization reports.
- Use the
Step 2: Query Organization Report
Execute the organizationReport
query to retrieve the specific report:
{
organizationReport(id: 456789123) {
id
name
cardCount
color
createdAt
lastUpdatedAt
fields
filter
sortBy {
field
direction
}
repos {
id
name
}
}
}
Response Example
{
"data": {
"organizationReport": {
"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", "priority"],
"filter": {
"status": ["in_progress", "review"],
"priority": ["high", "medium"]
},
"sortBy": {
"field": "due_date",
"direction": "ASC"
},
"repos": [
{
"id": "789123456",
"name": "Sales Pipeline"
},
{
"id": "789123457",
"name": "Lead Management"
},
{
"id": "789123458",
"name": "Customer Success"
}
]
}
}
}
Key Fields Explained
Report Information
id
: Unique identifier for the reportname
: Display name of the reportcardCount
: Total number of cards included in the report (calculated in real-time)color
: Hex color code for the report's visual representationcreatedAt
: Timestamp when the report was createdlastUpdatedAt
: Timestamp when the report was last modified
Report Configuration
fields
: Array of field names to display in the report columnsfilter
: JSON object containing filter criteria applied to the report- Can include complex filtering logic for status, priority, assignee, etc.
sortBy
: Object defining how cards are sorted in the reportfield
: The field name to sort by (e.g., "due_date", "priority", "created_at")direction
: Sort direction (ASC
for ascending,DESC
for descending)
Associated Resources
repos
: Array of pipes/databases included in the reportid
: Pipe/database IDname
: Pipe/database name