Downdetector
App Vendor: Downdetector
App Category: IT Services
Connector Version: 1.0.0
API Version: V2
About App
The Downdetector application provides early alerting on service issues, often before internal monitoring tools can detect a problem. The Downdetector application offers real-time status and uptime monitoring for hundreds of services, including telecommunication outages (internet, phone, and TV service), online banking problems, websites that go down, and apps that aren't working.
The Downdetector app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Search Company | This action searches and retrieves the list of companies that match the given query. |
Get Company Details | This action retrieves results for a given company in the Downdetector application, including company details, the latest reported locations with problems, tweets, and any baseline problem reports which may exist. |
Get 24 Hour Baseline for a Company | This action retrieves the baseline for a company to which we compare any current reports. |
Get Current Status | This action retrieves the current status of the company. |
Get Number of Reports For the Company | This action returns the number of reports for the given time and location for the given company. |
Get All Events for the Company | This action retrieves the events for the given company. |
Get All Domain | This action retrieves a list of all available domains. |
Get Site Details | This action retrieves the details for a specific site. |
Get List of Providers for Company | This action retrieves the list of providers for the given company. |
Get Providers Details | This action retrieves the details of a specific provider. |
Site Companies | This action retrieves the list of companies for the given site. |
Configuration Parameters
The following configuration parameters are required for the Downdetector app to communicate with the Downdetector enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username to authenticate Downdetector API. | Text | Required | |
Password | Enter the password to authenticate with the Downdetector API. | Password | Required |
Action: Search Company
This action searches and retrieves the list of companies that match the given query.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company name | Enter the company name to search. This search is not case-sensitive and also returns partial match results. Example: "Comcast" | Text | Required | |
Country | Enter the country to filter results. Example: "US" | Text | Optional | Allowed values:
Default value:
|
Category ID | Enter the category ID to filter the results. Example: "10" | Integer | Optional | Default value:
|
Example Request
[
{
"company_name": "Comcast",
"country": "US",
"category_id": "10"
}
]Action: Get Company Details
This action retrieves results for a given company in the Downdetector application, including company details, the latest reported locations with problems, tweets, and any baseline problem reports which may exist.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company ID | Enter the company ID of the company to retrieve the details. Example: "4" | Integer | Required | The Company ID can be retrieved using the Search Company action. |
Example Request
[
{
"company_id": "4"
}
]Action: Get 24 Hour Baseline for a Company
This action retrieves the baseline for a company to which we compare any current reports.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company ID | Enter the Company ID of the company to return the baseline data. Example: "4" | Integer | Required | You can retrieve the Company ID using the Search Company action. |
Example Request
[
{
"company_id": "4"
}
]Action: Get Current Status
This action retrieves the current status of the company.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company ID | Enter company ID to get the current status. Example: "4" | Integer | Required | The Company ID can be retrieved using the Search Company action. |
Latitude | Enter the latitude location coordinates. Example: 53.5104033474 | Integer | Optional | |
Longitude | Enter the longitude location coordinates. Example: 7.09205325687 | Integer | Optional | |
Threshold | Specify a threshold value. This checks if the status is above this threshold. If so, returns 'danger', if not, returns 'success' Example: "2" | Integer | Optional | |
Indicator | Specify the indicator value to check the current status of the indicator. This parameter works with the 'indicator_pct'. Example: "1.1.1.1" | Text | Optional | |
Indicator PCT | Checks if the given indicator is above this threshold. This is only true when the company breached the given threshold or calculated baseline. | Integer | Optional |
Example Request
[
{
"company_id": "4",
"latitude": "53.5104033474",
"longitude": "7.09205325687",
"threshold": "100",
"indicator": "1.1.1.1",
"indicator_pct": "80"
}
]Action: Get Number of Reports For the Company
This action returns the number of reports for the given time and location for the given company.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company ID | Enter company ID to get the reports. Example: "4" | Integer | Required | |
Start date | Enter the start date to get the reports. The date should be in ISO8601 format. Example: "2010-02-11t13:37:42+00:00" | Text | Optional | |
End date | Enter the end date to get the reports. The date should be in ISO8601 format. Example: "2010-02-11t13:37:42+00:00" | Text | Optional | |
Latitude | Enter the latitude of the location coordinates. Example: "53.5104033474" | Integer | Optional | |
Longitude | Enter the longitude of the location. Example: "7.09205325687" | Integer | Optional | |
ASN | Enter the ASN value. Example: "6432" | Integer | Optional | |
Interval | Enter the interval. Example: 15m (15 minutes) Other Examples: 1m, 5m, 10m, 1h, 24h, 1d, 2d, etc. | Text | Optional | Default value:
|
Offset | Enter the offset value. Example: 5m, 10m, 1h, etc.
Other examples: 10m, 1h, etc. | Text | Optional | Default value:
|
Example Request
[
{
"company_id": "4",
"latitude": "53.5104033474",
"longitude": "7.09205325687",
"asn": "6432",
"interval": "15m",
"offset": "5m"
}
]Action: Get All Events for the Company
This action retrieves the events for the given company.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company ID | Enter company ID to get all the events. Example: "4" | Integer | Required | |
Start date | Enter the start date to get the events. The date should be in ISO8601 format. Example: "2010-02-11t13:37:42+00:00" | Text | Optional | |
End date | Enter the end date to get the events. The date should be in ISO8601 format. Example: "2010-02-11t13:37:42+00:00" | Text | Optional | |
Page size | Enter the number of results to return per page. Example: "8" | Integer | Optional | Default value:
|
Page | Enter the page to retrieve the events. Example: "5" | Integer | Optional |
Example Request
[
{
"company_id": "4",
"start_date": "2010-02-11t13:37:42+00:00",
"end_date": "2010-02-11t13:37:42+00:00",
"page_size": "8",
"page": "5"
}
]Action: Get All Domains
This action retrieves a list of all available domains.
Action Input Parameters
This action does not require any input parameter.
Action: Get Site Details
This action retrieves the details for a specific site.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter site ID to get the details. Example: "40" | Integer | Required |
Example Request
[
{
"site_id": "40"
}
]Action: Get List of Providers for Company
This action retrieves the list of providers for the given company.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Company ID | Enter company ID to get the list of providers. Example: "5" | Integer | Required | |
Start date | Enter the start date to get the list of providers. The date should be in ISO8601 format. Example: "2010-02-11t13:37:42+00:00" | Text | Optional | |
End date | Enter the end date to get the list of providers. The date should be in ISO8601 format. Example: "2010-02-11t13:37:42+00:00" | Text | Optional | |
Latitude | Enter the latitude location coordinates. Example: "53.5104033474" | Integer | Optional | |
Longitude | Enter the longitude location coordinates. Example: "7.09205325687" | Integer | Optional |
Example Request
[
{
"company_id": "5",
"start_date": "2010-02-11t13:37:42+00:00",
"end_date": "2010-02-11t13:37:42+00:00",
"latitude": "53.5104033474",
"longitude": "7.09205325687"
}
]Action: Get Providers Details
This action retrieves the details of a specific provider.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Provider ID | Enter provider ID to get the details. Example: "32" | Integer | Required | The Provider ID can be retrieved using the Get List of Providers for Company action. |
Example Request
[
{
"provider_id": "32"
}
]Action: Site Companies
This action retrieves the list of companies for the given site.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter site ID to get the companies. Example: "32" | Integer | Required | |
Page size | Enter the number of results per page. Example: "8" | Integer | Optional | Default value:
|
Page | Enter the page to get the results. Example: "3" | Integer | Optional | |
Fields | Enter the fields to return in output. Example: "[id,name,slug,stats_24,baseline]" | List | Optional | Default value:
|
Order by | Enter parameter to order the results. Example: "status" | Text | Optional | Allowed values:
Default value:
|
Order direction | Enter the order direction. Example: "desc" | Text | Optional | Allowed values:
Default value:
|
Example Request
[
{
"site_id": "32",
"page_size": "8",
"page": "3",
"fields": "[id,name,slug,stats_24,baseline]",
"order_by": "status",
"order_dr": "asc",
}
]