Skip to main content Link Search Menu Expand Document (external link)

Search API Responses

Response Format

OneStop API responses are built around the JSON API Specification. Successful responses (with facets requested) are formatted as such, where the fields within the attributes object are specified here:

{  
"data": [
     {
       "id"        : "1",
       "type"      : "collection",
       "attributes": { ... }
     },
     {
       "id"        : "2",
       "type"      : "collection",
       "attributes": { ... }
     }
   ],
  "meta": {
    "took"  : 100,
    "total" : 2,
    "facets": {
      "science"             : [
        {
          "Oceans": {
            "count": 2
          }
        },
        {
          "Oceans > Bathymetry": {
            "count": 1
          }
        }
      ],
      "services"            : [],
      "locations"           : [],
      "instruments"         : [],
      "platforms"           : [],
      "projects"            : [],
      "dataCenters"         : [],
      "horizontalResolution": [],
      "verticalResolution"  : [],
      "temporalResolution"  : []
    }
  }
}