api.clarify.io
  1. bundles
api.clarify.io
  • bundles
    • List bundles
      GET
    • Create a bundle
      POST
    • Delete a bundle
      DELETE
    • Get a bundle
      GET
    • Update a bundle
      PUT
    • Get bundle insights
      GET
    • Request an insight to be run
      POST
    • Get bundle insight
      GET
    • Delete bundle metadata
      DELETE
    • Get bundle metadata
      GET
    • Update bundle metadata
      PUT
    • Delete bundle tracks
      DELETE
    • Get bundle tracks
      GET
    • Add a track for a bundle
      POST
    • Update a tracks for a bundle
      PUT
    • Delete a bundle track
      DELETE
    • Get bundle track
      GET
    • Add media to a track
      PUT
  • reports
    • Generate Group Report <span class="label">beta</span>
      GET
    • Generate Trends Report <span class="label">beta</span>
      GET
  • search
    • Search bundles
      GET
  • Schemas
    • Schemas
      • Bundle
      • BundleReport
      • Collection
      • Insight
      • Insights
      • ItemResult
      • MatchHit
      • Metadata
      • Ref
      • Ref (of Bundle)
      • Ref (of Track)
      • Ref_(of_Bundle)
      • Ref_(of_Track)
      • ReportPeriod
      • ReportPeriodBundle
      • SearchCollection
      • SearchTerm
      • TermMatch
      • TermResult
      • Track
      • Track_(array_item)
      • Tracks
      • object
  1. bundles

List bundles

GET
/v1/bundles
Gets the list of bundles. Links to each item are in the _links with link relation items.

After getting the initial list, use the first, last, next, prev link relations to get more bundles in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

The embed parameter specifies link relations to embed in the results. The models for the specified link relations will be in an array in the embedded object with the link relation as the key. For example, if you do embed=items, _embedded will contain a property items whose value is the array of bundle models. For link relations that are curies (ex. "clarify:metadata"), you may simply use the base name (ex. "metadata").

Request

Query Params

Responses

🟢200OK
application/json
Body

🟠400Bad request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.clarify.io//v1/bundles'
Response Response Example
200 - Example 1
{}
Modified at 2022-09-10 16:56:00
Next
Create a bundle
Built with