Working with Squirro APIs

Owned by Patrice Neff
Last updated: Feb 11, 2020 by Moritz Müller

The Squirro API provides access to all services/entities of Squirro, including the projects, subscriptions and items. The following pages describe the resources of this REST API grouped by scope.

Overview of APIs

Dashboards

Dashboards are used in projects to visualize the project data.

Enrichments

Enrichments are added to projects to change how incoming items are processed.

Facets API

Manage facets on a project.

Fingerprints

Smart Filters (called Fingerprints in the API for legacy reasons) enable concept search over Items in a project.

Items

Search items from a Squirro project.

Objects

Objects are used to group the sources in a project.

Pipeline Workflows

Pipeline Workflows control the steps applied to data imported into projects via subscriptions (referred to as Data Sources in the graphical user interface).

Preview

Previews are used to get subscription results without creating the subscription.

Projects

Projects are the main entry point in Squirro.

Scores

The scores resource does batch-calculations of fingerprints relevance for each item in a project.

Subscriptions

Subscriptions define how data is provided to a Squirro project.

Trend Detections

Trend Detection is configured on projects to look for anomalies in time series data.