Roaring logo

Data Updater

Update your data to current information, and smoothly add monitoring to keep up-to-date.

Data Updater

[global]
Requires addon

Endpoints

List available services

Get available services which could be used to start data updater task

gethttps://api.roaring.io/global/data-updater/1.0/services

Response schema: application/json

List data updater tasks performed by user

Fetch information about all data updater tasks performed by user

gethttps://api.roaring.io/global/data-updater/1.0/tasks

Start data updater task with file

Starts data updater task for specified services and companies from a file

puthttps://api.roaring.io/global/data-updater/1.0/startWithFile/{webhookId}

Parameters path

webhookId

required

string
Id of webhook to which to send data updater events
Request body schemamultipart/form-dataRequired
companyIds
stringtext file with company id-s each in a new line
services
arraylist of service names
Validate company ids file
Validate the file has good company ids
puthttps://api.roaring.io/global/data-updater/1.0/validate
Request body schemamultipart/form-dataRequired
file
stringtext file with company id-s each in a new line
Start data updater task
Starts data updater task for specified companies and services
puthttps://api.roaring.io/global/data-updater/1.0/start/{webhookId}
Parameters path
webhookId
required
string
Id of webhook to which to send data updater events
Request body schemaapplication/jsonRequired
Required fields: companyIds, services
companyIds
arrayArray of company identifiers for which to fetch data updater data
services
arrayArray of service names from which fetch data updater data
Get status of data updater task
Get status of data updater task for specified task id
gethttps://api.roaring.io/global/data-updater/1.0/status/{dataUpdaterId}
Parameters path
dataUpdaterId
required
string
Id of data updater task
Parameters query
withProtocol
boolean
Whether to include data updater task execution protocol, default false
List available webhooks
Get available webhooks which could be used to start data updater task
gethttps://api.roaring.io/global/data-updater/1.0/webhooks