GET: File Sharing Observation Details – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/companies/company_guid/observations?risk_types=file_sharing

Retrieve detailed information about a company's File Sharing observations.

Parameters

See GET: Detailed Company Observations for all available parameters.

* Required.

company_guid

* Required.

[Path] Identify the company to query.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

risk_types

* Required.

[Query] Identify the risk vector to query.

Value: [String] file_sharing

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/observations?risk_types=file_sharing' -u api_token:

Example Response

{
  "data":[
    […]
    {
      "risk_type":"file_sharing",
      "observation_id":"AAAAD2_IPppavK58AAAAAACd1oE=",
      "collection_date":"2023-03-31",
      "event_date":"2023-03-30",
      "forensics":{
        "host_ip":"188.134.66.168"
      },
      "details":{
        "occurrences":{
          "first_seen":"2023-03-30 10:40:21",
          "last_seen":"2023-03-30 10:40:21",
          "representative_timestamp":"2023-03-30 10:40:21",
          "count":1
        },
        "category":"MOVIES",
        "source_port":7321
      }
    }
  ],
  "cursors":{
    "next":"AAAABAAAAAc81HEafKXWqQ==",
    "next_url":"https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/observations?risk_types=file_sharing&cursor=AAAABAAAAAc81HEafKXWqQ%3D%3D"
  }
}

Response Attributes

Field					Description
data Array					File sharing observations.
	Object				An observation.
		risk_type String			The risk vector slug name.
		observation_id String			The observation identifier.
		collection_date String [`YYYY-MM-DD`]			The date when the observation was collected.
		event_date String [`YYYY-MM-DD`]			The date when the event occurred.
		forensics Object			Forensic details.
			host_ip String		The IP where the event was observed.
		details Object			Observation details.
			occurrences Object		Observation occurrence details.
				first_seen String [`YYYY-MM-DD HH:MM:SS`]	The starting date and time of this occurrence’s duration.
				last_seen String [`YYYY-MM-DD HH:MM:SS`]	The ending date and time of this occurrence’s duration.
				representative_timestamp String [`YYYY-MM-DD HH:MM:SS`]	The representative date and time of this occurrence.
				count Integer	The number of times this observation was counted.
			category String		The torrent category. See File Sharing categories.
			source_port Integer		The source port number.
cursors Object					Navigation to the next or previous page of results.
	next String				The next observation identifier.
	next_url String				The URL for navigating to the next page of results.

May 24, 2023: Published.

Parameters

Example Request

Example Response

Response Attributes

Related articles