API Reference

This section describes all the resources provided by the Squirro REST API.

The API is split up into a number of services. The User API is used for Authentication. All the other resources are available through the main API which is described in Working with Squirro APIs.

Common Headers

Common Status Codes

Working with Squirro APIs

  • DashboardsDashboards are used in projects to visualize the project data.
  • EnrichmentsEnrichments are added to projects to change how incoming items are processed.
  • Facets APIManage facets on a project.
  • FingerprintsSmart Filters (called Fingerprints in the API for legacy reasons) enable concept search over Items in a project.
  • ItemsSearch items from a Squirro project.
  • ObjectsObjects are used to group the sources in a project.
  • Pipeline WorkflowsPipeline Workflows control the steps applied to data imported into projects via subscriptions (referred to as Data Sources in the graphical user interface).
  • PreviewPreviews are used to get subscription results without creating the subscription.
  • ProjectsProjects are the main entry point in Squirro.
  • ScoresThe scores resource does batch-calculations of fingerprints relevance for each item in a project.
  • SubscriptionsSubscriptions define how data is provided to a Squirro project.
  • Trend DetectionsTrend Detection is configured on projects to look for anomalies in time series data.