Metadata API¶
Class for working with Crimson Hexagon account and analysis metadata.
Example usage¶
>>> from hexpy import HexpySession, MetadataAPI >>> session = HexpySession.load_auth_from_file() >>> metadata_client = MetadataAPI(session) >>> metadata_client.team_list()
Methods¶
team_list¶
team_list() -> JSONDict
Return a list of teams accessible to the requesting user.
monitor_list¶
monitor_list(team_id: int) -> JSONDict
Returns a list of monitors accessible to the user team along with metadata related to those monitors.
Arguments
- team_id: integer id number for a team
geography¶
geography() -> JSONDict
Return all the geographical locations that you may use to filter monitor results and to upload documents with location information.
states¶
states(country: str) -> JSONDict
Return all the states for a given country that you may use to filter monitor results and to upload documents with location information.
Arguments
- country: country code to filter states
cities¶
cities(country: str) -> JSONDict
Returns all the cities or urban areas defined in the given country that you may use to filter monitor results and to upload documents with location information.
Arguments
- country: country: country code to filter states
countries¶
countries() -> JSONDict
Returns all the countries that you may use to filter monitor results and to upload documents with location information.
image_classes¶
image_classes() -> JSONDict
Return list of all class IDs and names.
api_documentation¶
api_documentation() -> JSONDict
Return latest JSON version of Crimson Hexagon API endpoint documentation.