API cards and API tables provide a more flexible and customizable way to present information on your homepage, dashboards, or other overview pages.
API cards
API cards are used to display concise information about specific spaces, applications, or objects. They also serve as quick links to the mentioned e.g., space, other resources, or trigger additional details if necessary.
API cards can show a wide variety of information, including but not limited to:
- Space: Space name, number of objects in the space, short description, space owner, etc.
- Application: App name, number of objects in multiple spaces, a brief description, etc.
- Object: Object name, related space or app, and other metadata.
- Dashboard: Dashboard name, description.
Display Options
- Card view: Individual cards are presented as separate units.
- List view: Cards can also be displayed in a condensed list or table view for easy scanning of multiple items.
Optional Interactivity
While API cards can simply display information, they may also include optional interactive elements:
- Clickable Links: The card can link to spaces, applications, objects, or dashboards.
- Pop-up Details: Cards can include buttons that trigger a pop-up with more detailed information.
- Custom Links: Other links or actions can be configured based on specific needs.
API tables
API tables provide a tabular view of objects and metadata, offering a more structured and detailed format for presenting information. These tables can be added to homepages, app overview pages, or parent object pages, and they can be fully customized to display a wide range of object-specific information.
API tables support flexible column configurations to display the necessary information. In the next section, you will find common categories of columns that can be included.
Customizable columns
The columns in your API table can be customized by configuring the API table in packages. While that is for more advanced users, here is a non-exhaustive list of possible columns
| Category | Example column |
|---|---|
| 1. Basic information | Object name: The primary identifier or title of the object., ID or Unique identifier: A unique ID associated with the object (if applicable)., Path or URL: The object’s location or URL within the system., Space name: The name of the space where the object resides. |
| 2. Ownership | Assigned users: Any users assigned to manage or monitor the object., Data owner or steward: The entity or person who owns the rights to the data or object. |
| 3. Status and workflow | Workflow status: The current status of the object in its workflow (e.g., “In Progress,” “Completed”)., Approval status: Whether the object has been approved, rejected, or is awaiting review. |
| 4. Temporal data | Create date: When the object was created and who created it., Last updated: When the object was last modified and by whom. |
| 5. Descriptive attributes | Description: A brief summary or explanation of the object., Tags or categories: Any tags, labels, or categories associated with the object for easier organization., Object type: The specific type or classification of the object (e.g., document, image, workflow). |
| 6. Metrics and performance | Fullness score: A metric indicating how complete or populated the object is., Usage statistics: Data on how often the object has been accessed or modified., Activity history: A log of recent actions or changes made to the object. |
| 7. Custom fields and metadata | Custom metadata fields: Any other user-defined or system-generated metadata associated with the object. |
Actions
Through the configuration of api-table properties using packages, the following features can be added.
| Action | Description |
|---|---|
| Mass-editing and bulk actions | Bulk actions can be performed on multiple objects simultaneously. Users with the appropriate permissions can mass-edit fields such as workflow status or ownership, streamlining the process of managing large datasets. |
| Action buttons | Custom buttons can be added to tables, enabling users to trigger specific actions, such as running SQL-based tasks. |
| Tabs with quick filters | Quick filter tabs can be integrated into the table to provide immediate access to specific subsets of data. For example, filters might include “Recently Updated,” “Owned by Me,” or “In Progress,” allowing users to focus on relevant data quickly. |