Magidoc

Query
Object

Query type

Fields

#

actionsTypes

Returns the list with the actions types present in the platform

alert

Through an alert code you can perform a search for more information through the query alert(alertCode: $alertCode), in this request you will inform the alert code and the API will return the main information. The result can be customized by you, for this example the request will return information such as biomes, cities, crossed properties, sources and the alert geometry.

alertDateRange

Non-null

Maximum and minimum publication dates of alerts, being that alert publications are weekly

alertStatusByBiomes

Non-null

Alert status by biomes

alerts

Non-null

The query alerts is used to search for alerts published on the platform. It has filters such as: publication date and detection date, size, search area, etc. The result will be a paginated list of alerts.

areasOfInterest

[ MyMap !]

The areas of interest are the way a user monitors a particular area of interest for current and future alerts. To query your areas of interest, use the myMaps() query. The request will return all areas of interest already created by your user.

currentlyInPrivacyNotice

Non-null

Returns the privacy notice currently in use on the platform

currentlyInTermOfUse

Non-null

Returns the current terms of use on the platform

downloadShapefile

Non-null

download_shape

findLastUpdateRelatory

findSuspendedJudicialAlert

institutionsCsvExport

lastAlertPublication

Non-null

Returns the last date when alerts were published on the platform and the number of alerts that were published

platformFeatureFlags

Non-null

Returns the platform feature flags and their respective status (enabled/disabled)

pointInformation

Non-null

Returns the information of territories that cross the searched point

relatoryAlert

You will need to download all alerts in the desired format (csv/shapefile) and also the type of content of the file (alerts or alerts with crossing with Rural Property)

relatoryAttributes

ruralProperty

Perform an alert search from a rural property (CAR/SIGEF/SNCI) through the query ruralProperty(carCode: $carCode) . The request requires a Rural Property crossed with alerts in our database and returns a list with all alerts linked to this specific rural property

supportCases

Non-null

Returns the support cases of the user that is making the request

territoryOptions

Non-null

You can query all territories of the platform through the query territory_options(category: $category). The request has a parameter for the type of territory (biomes, municipalities, conservation areas, etc) and will return all territories that you can use to perform alert search.

usersAndInstitutionsXlsxExport

usersCsvExport

version

Non-null

Show the current version of the API