File name templating

Learn to specify file names for results delivered to your cloud storage.

By default, result files delivered to your cloud storage use the {{ job_id }}.{{ extension }} naming template (e.g., 7346445033316311041.json). You can specify a custom file naming template for results delivered to your cloud storage.

Here's why you may want to do it:

• The result file names can be more informative
• Results can be automatically organized into different directories.

Template variables

You can use any input parameter you provide when creating a job, as well as any variable from the job object returned with your results (for example job_id, source, created_at) in your file naming template. The storage_url field of the job response shows the resolved path, so you can check a template without waiting for the upload.

Usage

1

Example 1: Custom file name with multiple variables

Writes the result to oxylabs.test/google_search_test_7336001481897673729.json

{
    "source": "google_search",
    "query": "test",
    "storage_type": "s3",
    "storage_url": "oxylabs.test/{{ source }}_{{ query }}_{{ job_id }}.{{ extension }}"
}

2

Example 2: Directory organization

Writes the result to oxylabs.test/google_search/7336001481897673729.json

{
    "source": "google_search",
    "query": "test",
    "storage_type": "s3",
    "storage_url": "oxylabs.test/{{ source }}/"
}

3

Example 3: Custom directory with custom file name

Writes the result to oxylabs.test/google_search/oxylabs_test_7336001481897673729.json

{
    "source": "google_search",
    "query": "test",
    "storage_type": "s3",
    "storage_url": "oxylabs.test/{{ source }}/oxylabs_{{ query }}_{{ job_id }}.{{ extension }}"
}