Run Actor synchronously without input and get dataset items
Runs a specific Actor and returns its dataset items. The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds otherwise the API endpoint returns a timeout error. The Actor is not passed any input.
It allows to send all possible options in parameters from Get Dataset Items API endpoint.
Beware that it might be impossible to maintain an idle HTTP connection for a long period of time, due to client timeout or network conditions. Make sure your HTTP client is configured to have a long enough connection timeout. If the connection breaks, you will not receive any information about the run and its status.
To run the Actor asynchronously, use the Run Actor API endpoint instead.
Path parameters
Actor ID or a tilde-separated owner's username and Actor name.
Query parameters
Optional timeout for the run, in seconds. By default, the run uses the timeout from its configuration.
Memory limit for the run, in megabytes. You can set the amount of memory to a power of 2 with a minimum of 128. By default, the run uses the memory limit from its configuration. Don't change this value unless the Actor's documentation recommends it or you're aware of the consequences.
Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. Only works for pay-per-result Actors. Value can be accessed in the actor run using ACTOR_MAX_PAID_DATASET_ITEMS environment variable.
Specifies the maximum total cost of the run. Use it to cap the total amount charged for all pricing models. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.
Determines whether the run will be restarted if it fails.
Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build from its configuration (typically latest).
Specifies optional webhooks associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array whose items follow the WebhookRepresentation schema. For more information, see Webhooks documentation.
Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.
If true or 1 then the API endpoint returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skipHidden=true and skipEmpty=true parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.
Number of items that should be skipped at the start. The default value is 0.
Maximum number of items to return. By default there is no limit.
A comma-separated list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields query parameter. You can use this feature to effectively fix the output format.
A comma-separated list of output field names that positionally rename the fields specified in the fields parameter. For example, ?fields=headline,url&outputFields=title,link renames headline to title and url to link in the output. The number of names in outputFields must match the number of names in fields. Requires the fields parameter to be specified as well.
A comma-separated list of fields which should be omitted from the items.
A comma-separated list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.
A comma-separated list of fields which should transform nested objects into flat structures.
For example, with flatten="foo" the object {"foo":{"bar": "hello"}} is turned into {"foo.bar": "hello"}.
The original object with properties is replaced with the flattened object.
By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to true or 1.
If true or 1 then the response will define the Content-Disposition: attachment header, forcing a web browser to download the file rather than to display it. By default this header is not present.
A delimiter character for CSV files, only used if format=csv. You might need to URL-encode the character (e.g. use %09 for tab or %3B for semicolon). The default delimiter is a simple comma (,).
All text responses are encoded in UTF-8 encoding. By default, the format=csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not.
If you want to override this default behavior, specify bom=1 query parameter to include the BOM or bom=0 to skip it.
Overrides default root element name of xml output. By default the root element is items.
Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.
If true or 1 then header row in the csv format is skipped.
If true or 1 then hidden fields are skipped from the output, i.e. fields starting with the # character.
If true or 1 then empty items are skipped from the output.
Note that if used, the results might contain less items than the limit value.
If true or 1 then, the endpoint applies the fields=url,pageFunctionResult,errorInfo and unwind=pageFunctionResult query parameters. This feature is used to emulate simplified results provided by the legacy Apify Crawler product and it's not recommended to use it in new integrations.
Defines the view configuration for dataset items based on the schema definition. This parameter determines how the data will be filtered and presented. For complete specification details, see the dataset schema documentation.
If true or 1 then, the all the items with errorInfo property will be skipped from the output.
This feature is here to emulate functionality of API version 1 used for the legacy Apify Crawler product and it's not recommended to use it in new integrations.
Overrides the auto-generated RSS channel <title> element. Only used when format=rss. If not provided, the title defaults to Dataset <label>.
Overrides the auto-generated RSS channel <description> element. Only used when format=rss. If not provided, the description defaults to Items in dataset with id "<datasetId>".