Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST Endpoints

Excerpt

The Open Data API is a JSON REST API. It has 4 root REST endpoints:

/schema
Provides information about all the SuperSTAR datasets that are available to you, and their fields and measures.Learn More
/table
Allows you to submit queries and receive the results (equivalent to creating a table in SuperWEB2).Learn More
/info
Provides general information about the SuperWEB2 instance you are connecting to. At present, this endpoint provides information about the dataset languages currently configured in SuperWEB2.Learn More
/rate_limit

Access to the API is subject to rate limits. This endpoint provides information about the limit that applies to you, how many requests you have remaining, and the length of time before the rate limit will be reset.

From version 9.9.1 onwards, there are two additional rate limit endpoints: /rate_limit_table and /rate_limit_schema.

Learn More

API Key

In order to use the API, you will need an API key. This needs to be included in an APIKey header in every request you submit to the API. Learn about how to obtain your API key.

...