Report and Activity

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/sigact
  • Auth
    none declared

Query parameters

reportDatestring date-time required

Date of the report or filing. (YYYY-MM-DDTHH:MM:SS.sssZ)

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

sourceLanguagestring

The source language of the significant event using the ISO 639-3, 3 character code definition.

countryCodestring

The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

citystring

The city in or near which this event occurred.

districtstring

The district in which this event occurred.

provincestring

The province in which this event occurred.

latnumber double

WGS-84 centroid latitude of the event location, in degrees. -90 to 90 degrees (negative values south of equator).

lonnumber double

WGS-84 centroid longitude of the event location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

milgridstring

The Military Grid Reference System is the geocoordinate standard used by NATO militaries for locating points on Earth. The MGRS is derived from the Universal Transverse Mercator (UTM) grid system and the Universal Polar Stereographic (UPS) grid system, but uses a different labeling convention. The MGRS is used as geocode for the entire Earth.

Example of an milgrid coordinate, or grid reference, would be 4QFJ12345678, which consists of three parts:

4Q (grid zone designator, GZD)

FJ (the 100,000-meter square identifier)

12345678 (numerical location; easting is 1234 and northing is 5678, in this case specifying a location with 10 m resolution).

theaterstring

Area in which important military events occur or are progressing. A theater can include the entirety of the airspace, land and sea area that is or that may potentially become involved in war operations.

atextstring

Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known Text representation of the geometry/geography, of the image as projected on the ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored if included with a POST or PUT request that also specifies a valid 'area' field.

agjsonstring

Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON representation of the geometry/geography, of the image as projected on the ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST or PUT request that also specifies a valid 'area' or 'atext' field.

atypestring

Type of region as projected on the ground.

andimsinteger

Number of dimensions of the geometry depicted by region.

asridinteger

Geographical spatial_ref_sys for region.

eventStartstring date-time

The approximate start time of the event, in ISO 8601 UTC format.

eventEndstring date-time

The approximate end time of the event, in ISO 8601 UTC format.

reportDatestring date-time required

Date of the report or filing.

actorsstring[]

A list of one or more actors involved in the event.

civAbdinteger

Number of civilians abducted in the activity.

civDetinteger

Number of civilians detained in the activity.

civKIAinteger

Number of civilians killed in the activity.

civWoundinteger

Number of civilians wounded in the activity.

coalAbdinteger

Number of coalition members abducted in the activity.

coalDetinteger

Number of coalition members detained in the activity.

coalKIAinteger

Number of coalition members killed in the activity.

coalWoundinteger

Number of coalition members wounded in the activity.

enemyAbdinteger

Number of enemy combatants abducted in the activity.

enemyDetinteger

Number of enemy combatants detained in the activity.

enemyKIAinteger

Number of enemy combatants killed in the activity.

friendlyAbdinteger

Number of friendlies abducted in the activity.

friendlyDetinteger

Number of friendlies in the activity.

friendlyKIAinteger

Number of friendlies killed in the activity.

friendlyWoundinteger

Number of friendlies wounded in the activity.

hostNatAbdinteger

Number of Host Nation members abducted in the activity.

hostNatDetinteger

Number of Host Nation members detained in the activity.

hostNatKIAinteger

Number of Host Nation members killed in the activity.

hostNatWoundinteger

Number of Host Nation members wounded in the activity.

sideAAbdinteger

Number of side A members abducted in the activity.

sideADetinteger

Number of side A members detained in the activity.

sideAKIAinteger

Number of side A members killed in the activity.

sideAWoundinteger

Number of side A members wounded in the activity.

sideBAbdinteger

Number of side B members abducted in the activity.

sideBDetinteger

Number of side B members detained in the activity.

sideBKIAinteger

Number of side B members killed in the activity.

sideBWoundinteger

Number of side B members wounded in the activity.

targetstring

The name of the target. The target may be an individual, an entity, or a country/region.

eventDescriptionstring

A description of the event.

eventTypestring

The type of event (e.g. Military, Natural, Political, Social, etc.).

typeOfAttackstring

The mode of this attack or event (e.g. Direct Fire, IED Explosion, etc.).

complexAttackboolean

Flag indicating that this attack was of a complex or coordinated nature.

idNumberstring

Unique identifier assigned to each event record that uniquely identifies it in the master dataset. This ID is provided for convenience of mapping to external systems.

confidenceinteger

Estimate of the confidence that this event occurred.

accuracyinteger

Estimate of the accuracy that this event occurred as described/reported.

clarityinteger

1 (high) for events where the reporting allows the coder to identify the event in full. That is, events where the individual happening is described by the original source in a sufficiently detailed way as to identify individual incidents, i.e. separate activities of fighting in a single location:

2 (lower) for events where an aggregation of information was already made by the source material that is impossible to undo in the coding process. Such events are described by the original source only as aggregates (totals) of multiple separate activities of fighting spanning over a longer period than a single, clearly defined day.

cameoCodestring

This is the raw CAMEO action code describing the action that Actor1 performed upon Actor2. Additional information about Cameo Codes can be obtained from the GDELT project documentation here: https://www.gdeltproject.org/data.html#documentation.

cameoBaseCodestring

CAMEO event codes are defined in a three-level taxonomy. For events at level three in the taxonomy, this yields its level two leaf root node. For example, code 0251 (Appeal for easing of administrative sanctions) would yield an EventBaseCode of 025 (Appeal to yield). This makes it possible to aggregate events at various resolutions of specificity. For events at levels two or one, this field will be set to EventCode.

cameoRootCodestring

Similar to EventBaseCode, this defines the root-level category the event code falls under. For example, code 0251 (Appeal for easing of administrative sanctions) has a root code of 02 (Appeal). This makes it possible to aggregate events at various resolutions of specificity. For events at levels two or one, this field will be set to EventCode.

goldsteinnumber double

Each CAMEO event code is assigned a numeric score from -10 to +10, capturing the theoretical potential impact that type of event will have on the stability of a country. This is known as the Goldstein Scale. NOTE: this score is based on the type of event, not the specifics of the actual event record being recorded thus two riots, one with 10 people and one with 10,000, will both receive the same Goldstein score. This can be aggregated to various levels of time resolution to yield an approximation of the stability of a location over time.

documentSourcestring

The source of the document or report.

documentFilenamestring

The filename of the document or report.

hasAttachmentboolean

Flag indicating this SigAct record has an associated txt file stored in the UDL. Retrieve the txt file by using the GET/udl/sigact/getFile/{id} where id is the same as the SigAct record id. The maximum file size for this service is 10,000,000 bytes (10MB). Files exceeding the maximum size will be rejected.

filesizeinteger

Size of the associated text file. Units in bytes. If filesize is provided without an associated file, it defaults to 0.

checksumValuestring

MD5 value of the file. The ingest/create operation will automatically generate the value.

repUnitstring

The reporting unit.

repUnitTypestring

The reporting unit type.

repUnitActivitystring

The activity the unit was engaged in.

numMentionsinteger

This is the total number of mentions of this event across all source documents during the 15 minute update in which it was first seen. Multiple references to an event within a single document also contribute to this count. This can be used as a method of assessing the importance of an event: the more discussion of that event, the more likely it is to be significant.

numSourcesinteger

This is the total number of information sources containing one or more mentions of this event during the 15 minute update in which it was first seen. This can be used as a method of assessing the importance of an event: the more discussion of that event, the more likely it is to be significant.

numArticlesinteger

This is the total number of source documents containing one or more mentions of this event during the 15 minute update in which it was first seen. This can be used as a method of assessing the importance of an event: the more discussion of that event, the more likely it is to be significant.

avgTonenumber double

This is the average tone of all documents containing one or more mentions of this event during the 15 minute update in which it was first seen. The score ranges from -100 (extremely negative) to +100 (extremely positive). Common values range between -10 and +10, with 0 indicating neutral.

sourceUrlstring

This field records the URL or citation of the first news report it found this event in. In most cases this is the first report it saw the article in, but due to the timing and flow of news reports through the processing pipeline, this may not always be the very first report, but is at least in the first few reports.

summarystring

A summary of the event.

notesstring

Notes related to the documents or event.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system, example = 2018-01-01T16:00:00.123Z.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourcestring required

Source of the data.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "id": "SIGACT-ID",
    "classificationMarking": "U",
    "sourceLanguage": "eng",
    "countryCode": "US",
    "city": "Austin",
    "district": "district 12",
    "province": "Province_Example",
    "lat": 45.31,
    "lon": 90.23,
    "milgrid": "4QFJ12345678",
    "theater": "Kabul",
    "atext": "POLYGON((67.3291113966927 26.156175339112,67.2580009640721 26.091022064271,67.1795862381682 26.6637992964562,67.2501237475598 26.730115808233,67.3291113966927 26.156175339112))",
    "agjson": "{\"type\":\"Polygon\",\"coordinates\":[ [ [ 67.3291113966927, 26.156175339112 ], [ 67.2580009640721, 26.091022064271 ], [ 67.1795862381682, 26.6637992964562 ], [ 67.2501237475598, 26.730115808233 ], [ 67.3291113966927, 26.156175339112 ] ] ] }",
    "atype": "Type1",
    "andims": 3,
    "asrid": 3,
    "eventStart": "2021-01-01T01:02:03.123Z",
    "eventEnd": "2021-01-01T01:02:03.123Z",
    "reportDate": "2018-01-01T16:00:00.123Z",
    "actors": [
      "US",
      "CAN"
    ],
    "civAbd": 423,
    "civDet": 234,
    "civKIA": 2,
    "civWound": 123,
    "coalAbd": 123,
    "coalDet": 123,
    "coalKIA": 123,
    "coalWound": 123,
    "enemyAbd": 123,
    "enemyDet": 123,
    "enemyKIA": 123,
    "friendlyAbd": 123,
    "friendlyDet": 123,
    "friendlyKIA": 123,
    "friendlyWound": 123,
    "hostNatAbd": 123,
    "hostNatDet": 123,
    "hostNatKIA": 123,
    "hostNatWound": 123,
    "sideAAbd": 123,
    "sideADet": 123,
    "sideAKIA": 123,
    "sideAWound": 123,
    "sideBAbd": 123,
    "sideBDet": 123,
    "sideBKIA": 123,
    "sideBWound": 123,
    "target": "US",
    "eventDescription": "Example_Description",
    "eventType": "Military",
    "typeOfAttack": "IED Explosion",
    "idNumber": "NUMBER-ID",
    "confidence": 13,
    "accuracy": 13,
    "clarity": 1,
    "cameoCode": "CAMEO_CODE",
    "cameoBaseCode": "Example_cameoBaseCode",
    "cameoRootCode": "Example_cameoRootCode",
    "goldstein": 9.32,
    "documentSource": "Example_documentSource",
    "documentFilename": "Example_documentFilename",
    "hasAttachment": true,
    "checksumValue": "120EA8A25E5D487BF68B5F7096440019",
    "repUnit": "Unit_1",
    "repUnitType": "Example_repUnitType",
    "repUnitActivity": "Example_Activity",
    "numMentions": 8,
    "numSources": 8,
    "numArticles": 8,
    "avgTone": 8.23,
    "sourceUrl": "Example_URL",
    "summary": "Example_Summary",
    "notes": "Example_Notes",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

    • breaking

      the / response's property format changed from int32 to int16 for status

    • info

      api operation id findAll_112 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.