Raptor Maps' Field Glossary

This is a glossary for the fields Raptor Maps uses in requests and responses.

Field NameData TypePurpose
ac_size_megawattsintegerTranslated value from DC to AC
access_codestringInformation to access the physical farm
actionjson objectObject with information about suggested action
addressstringPhysical address of the farm
annual_power_impact_visiblebooleanReport view option
anomalystringAnomaly type
anomaly_countintegerNumber of anomalies of certain type identified in an inspection
anomaly_life_cyclejson objectLife cycle Object
anomaly_locations_visiblebooleanReport view option
anomaly_map_descriptionbooleanOptional notes for inspection quality check
anomaly_map_visiblebooleanReport view option
annual_monetary_impact_visiblebooleanReport view option
anomalies_examples_visiblebooleanReport view option
asset_idstringExternal unique identifier for integrated systems
avg_tempfloatAverage temp at time of inspection
client_org_idintegerInternal value showing the originating org for the farm.
cloud_coverstringCloud cover at time of inspection
commisioning_tsecsfloatDate of farm commissioning displayed in unix epoch
contact_uuidstringIdentifier for farm contact
coordinateslistGeo-location for anomaly
countrystringCountry where farm is located
creator_idstringUser ID for the object creator
created_tsecsfloatDate of object creation in Raptor Maps in unix epoch
custom_locator_textstringCustom numbering for equipment location
data_capture_visiblebooleanReport view option
defect_action_visiblebooleanReport view option
delta_tfloatDifference in temperature between non-anomalous modules and the identified anomaly
delta_t_visiblebooleanReport view option
est_affected_dc_kwfloatThe estimated affected power of the anomaly.
est_affected_dc_percentfloatThe estimated affected power of the anomaly is divided by the total site's power and represented as a percent.
est_annual_impact_kw_hfloatThe estimated annual impact in kilowatt-hours is the estimated affected power multiplied by the site's peak sunlight hours.
est_annual_impact_dollarsfloatThe estimated annual impact in money is the estimated annual impact in kilowatt-hours multiplied by the money per kilowatt-hour i.e. power purchase agreement (PPA) rate.
farm_obectjson objectContains information about the farm on which the anomaly was found
feedbackstringNotes about the anomaly
findings_visiblebooleanReport view option
flight_boundarystringData object that describes boundary of inspection flight
geomgeometry objectLocation of object
group_namestringLogical grouping for the anomaly
idintegerUnique ID number for the object.
imaging_systemstringModel of camera used for inspection
inspection_idintegerID of the inspection which found the anomaly
inspection_tsecsfloatTime of the inspection in unix epoch
inspection_tsecs_endfloatTime inspection ended in unix epoch
inspection_uuiduuidUUID for the inspection associated with the anomaly
irradiancefloatAvailable irradiance when the inspection took place
irradiance_tsecsfloatTime when the irradiance was measured
latitudefloatGeolocation for the object, with Longitude field
linked_image_filenamestringFile name for the secondary image associated with the anomaly
linked_image_idstringIdentifier of the secondary image associated with the anomaly
linked_image_urlstringURL of the secondary image associated with the anomaly
linked_thumbnail_urlstringURL of the secondary thumbnail associated with the anomaly
localize_anomalies_visiblebooleanReport view option
localize_descriptionstringNotes from farm creation
longitudefloatGeolocation for the object, with Latitude field
max_tempfloatMaximum measured temperature on the panel
min_tempfloatMinimum measure temperature on the panel
modulesintegerThe number of modules affected by a specific anomaly. For module anomalies, this will be one-to-one. For string and row anomalies, this will provide sum of the modules affected.
module_layoutstringNumber of modules per string
module_mountstringDescription of the mounting technology used on the farm
namestringName of the object
norm_delta_tfloatNormalized delta t measurement
notationstringNotation type used for farm
object_notation_jsonjson objectStandard numbering for equipment location
object_typestringThe anomaly type
order_uuidstringUUID for order that created the inspection
org_idintegerID of org that owns the data
org_power_factorfloatThe amount the anomaly reduces power generation as set by the parent org. Found in the tag object
ppa_ratefloatPower Purchasing Authority's rate
peak_sunlight_hours_annualintegerNumber of hours of estimated sunshine per year. Defaults to 1500.
peak_sunlightintegerNumber of hours of estimated sunshine per year. Defaults to 1500.
power_inspectedfloatHow much power was inspected
power_factorfloatRaptor Maps default value for the amount the anomaly reduces power generation. Found in the tag object
primary_image_filenamestringFile name of the primary image associated with the anomaly
primary_image_idintegerIdentifier of the primary image associated with the anomaly
primary_shape_idintegerThe ID of the shape of identified anomaly
primary_image_urlstringURL of the primary image associated with the anomaly
primary_thumbnail_urlstringURL of the primary thumbnail associated with the anomaly
priorityintegerPriority level of an identified anomaly
quality_checkedbooleancheck for inspection quality control
rel_humidityintegerHumidity levels during inspection
row_child_process_statusintegerAsynchronous job status
sensor_idintegerID of sensor used to measure temperature
site_layoutstringFarm configuration indicators
site_overview_visiblebooleanReport view option
sizeintegerFarm size in MW
solar_module_idintegerID for the solar module type
solar_farm_idstringID of the inspected farm
source_farm_uuiduuidIdentifier for farm
statestringState in which the farm is built
statusintegerIndicator of object status
summary_textstringNotes for inspection
tagjson objectObject with information about anomaly type
tag_display_textstringText name of the anomaly type.
tag_idintegerID number for the anomaly tag
temperaturefloatOutside temperature at time of inspection. Measured in Celsius
thermal_overlay_visiblebooleanReport view option
timezonestringTime zone for the farm location
titlestringInspection Title
typestringShape of the anomaly
uas_modelstringModel of drone used for the inspection
updated_tsecsfloatDate of the last update to the object in unix epoch
uuidstringUnique identifier for the object.
verifiedbooleanVerification of inspection
versionintegercurrent version of the object
wind_speedfloatWind speed at time of inspection. Measured in km/h

action

The action object contains information about the suggested action for a given anomaly. The primary field is the "action" field which contains a string value with the name of the suggested action. Possible values are CLAIM, NO_ACTION, REPAIR, REPLACE, TRACK, UNSPECIFIED.

"action": {
        "action": <string>, -- enumerated value from list above
        "action_source": "system_specified",
        "created_tsecs": <integer>,
        "creator_id": <integer>,
        "defect_id": <integer>,
        "id": <integer>,
        "inspection_id": <integer>,
        "status": 1,
        "updated_tsecs": <integer>,
        "updator_id": <integer>
    },
Field NamePurpose
actionThe recommended or chosen action.
action_sourceThis is always set to system_specified.
created_tsecsThe time the action was set. This is represented in Unix Epoch time signature and is in UTC.
creator_idThe ID of the user that created the action. This user will usually be Raptor Maps.
defect_idThe ID of the anomaly for which the action is recommended.
idThe ID of the action object.
inspection_idThe ID of the inspection associated with the anomaly.
statusThis will always be 1.
updated_tsecsThe time the action was updated. This is represented in Unix Epoch time signature and is in UTC.
updator_idThe ID of the user that updated the action.

anomaly_life_cycle

The anomaly life cycle object consists of two values, an ID and a status. The ID is a numerical representation of the status. The status is a string description of the anomaly status.

Life Cycle IDStatusDescription
1DetectedThis anomaly was recently found
2VerifiedThis anomaly's existence has been verified
3ResolvedThis anomaly has been remediated
4Not FoundThis anomaly can no longer be identified

object_notation_json

Raptor Maps' new standard for object locator text. Each notation object contains a row name, string name, module name. These refer to the physical equipment on the farm and a full explanation can be found in our knowledge hub. For the API response. Each notation element contains an x and a y component, the default goes west to east, and north to south respectively.

If an object's location is 2,29,6,1,4,2 we can break that into three pairs.
2, 29 means the second row in the x direction, 29th row in the y direction
6, 1 means the 6th string horizontally into the row, and the 1st string vertically
4,2 gives us the location of the module, 4th in the string, in the 2nd segment of the string

In our API response that will look like this:

"object_notation_json": {
            "row": {
                "object_name": "2,29",
                "prefix": "",
                "rule_index": 0
            },
            "string": {
                "object_name": "6,1",
                "prefix": "",
                "rule_index": 1
            },
            "module": {
                "object_name": "4,2",
                "prefix": "",
                "rule_index": 2
            }
        },

object_type

This field describes the equipment level at which the anomaly was found. Values are module, row, or string. For instance, cracking would be a module level anomaly; tracker mounts would be a row level; and wiring might affect an entire string.

priority

This field describes the priority level assigned to a particular anomaly. The first level of priority is determined automatically by Raptor Maps based on the anomaly type but can be changed.

Priority levelStatus
0None
1Low
2Medium
3High
4Completed
5Unset

tag

The tag object contains information about the anomaly type. The tag field is the primary field in the object and is the identifier for the anomaly. The tag_display_text is a string description corresponding to the tag id.

The structure of the tag object is this:

"tag": {
                "color": <string>,
                "id": <integer>,
                "org_power_factor": <float>,
                "power_factor": <float>,
                "tag": <string>,
                "tag_display_text": <string>
            },
Field NamePurpose
colorUsed by the web app to determine the color with which to display the anomaly.
idThe tag id. This ID corresponds to the type of the anomaly. A shading anomaly, for instance, will have an id of 9619.
org_power_factorThis serves the same function as the power_factor. The difference is the number comes from the org owner and not from Raptor Maps. This can be set in the Raptor Maps web app.
power_factorThis is the by Raptor Maps to calculate the loss in power from the anomaly compared to a nominally functioning panel.
tagThis is the plain text name for the anomaly type.
tag_display_nameThis is used by the web app to display an anomaly name if it differs from the standard name set in the tag field.