Status Page

Start a webserver with the status page

Use following input for starting a status page server:

1{
2    "task": "serve",
3    "intervals": ["day", "week", "two-weeks", "month", "two-months"],
4    "charts": [
5        {
6            "id": "my-chart-1",
7            "name": "Name of my chart",
8            "showTable": true
9        },
10        ...
11    ]
12}

• intervals - array with time intervals that should be displayed, possible value are "day", "week", "two-weeks", "month", "two-months"
• charts - array of charts that should be displayed on the dashboard
  • id - string - an unique id of this chart. Will be used to store data.
  • name - string - name of chart that will be displayed on the dashboard
  • showTable - false by default. If true then there will be a table under the chart with the name of actor and daily dataset size

You will see following line in actor log:

Listenig on https://ar2nyyoqxcnn.runs.apify.net!

Copy this url to your browser and get ready to be amazed 😎🍿

Persistent url

Every actor starts with public URL which is different for every run. You can use rebrand.ly app to have a persistent URL. Actor is prepared to update your rebrand.ly with every start. Just add this to the input:

1{
2     "rebrandly": {
3         "id": "LinkId",
4         "apiKey": "YourApiKey",
5         "workspace": "YourWorkspaceId",
6         "title": "My cool dashboard"
7     },
8     ...
9 }

Storing data

Webhooks can be used to store dataset statistics or call store task using Apify.call directly from your actor. Use following input for storing a dataset info manually:

1{
2    "task": "store",
3    "name": "actor-name",
4    "datasetId": "datasetId",
5    "chartId": "my-chart-1",
6    "color": "#0084d5",
7}

• name - string - a name of actor or site it crawles.
• datasetId - string - an id of dataset
• chartId - string - an id of a chart
• color - optional string - what color (in hex format) should be used to display data. If not set some color will be picked randomly.

Using webhooks to store data

Just create a webhook under your actor or task for Run succeeded event. Set the url to start dashboard task. Actor will open default dataset of finished run and collect its statistics.

You can add a custom name to the payload template as "name": "hackernews.com". If there is no name set, then dashboard will lookup actor name and use that as a name for data line. Same with color or chartId attributes.