Skip to end of metadata
Go to start of metadata

This section describes all the resources provides 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 Entities.

Common Headers

Common Status Codes

Glossary

Working with Entities

  • DashboardsDashboards are used in projects to visualize the project data.
  • EnrichmentsEnrichments are added to projects to change how incoming items are processed.
  • FacetsManage 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.
  • 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.

  • No labels