Reporting API Code Samples

Selection of code samples that demonstrate the use of the Reporting API. Copy and edit these code samples to suit your needs.

When using the code samples, remember to replace:

{vanity_name} with your tenant name
{api_key} with your API key
{security_token} with a valid security token

These code samples may not include all available parameters and request body fields for each endpoint. For the endpoint's full request schema, see "Reporting" in Visier API Reference.

Retrieve a list of reports

Use this sample request to retrieve a list of reports.

Copy

cURL sample request: Retrieve a list of reports

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/reporting/reports' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns a list of reports with information such as the unique ID, title, description, owner, and the allowed actions you can take on the report. Use the returned link to direct users to the report; for example, link to the report in an embedded iframe.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
    "reports": [
        {
            "id": "ca98be3d-8569-488b-be51-757d14bccb2f",
            "title": "Callisto report",
            "updatedTime": "1737159932616",
            "isPublishedReport": true,
            "owner": "3895404b-e08b-1549-9ac5-51f44e3bd442",
            "allowedActions": [
                "duplicate",
                "download"
            ],
            "link": "#/analytics/reporting/ca98be3d-8569-488b-be51-757d14bccb2f"
        },
        {
            "id": "a4e20e3d-8569-488b-be51-757d14bccb2f",
            "title": "Callisto report 2",
            "updatedTime": "1737159930073",
            "owner": "f3ab0a40-d12f-1c4e-97c9-12817ed96d9b",
            "isOwnedByUser": true,
            "allowedActions": [
                "duplicate",
                "delete",
                "edit",
                "download",
                "share"
            ],
            "link": "#/analytics/reporting/a4e20e3d-8569-488b-be51-757d14bccb2f"
        }
    ]
}

Retrieve a report's details

Use this sample request to retrieve the details of a specific report. You must know the ID of the report to retrieve its details. To retrieve report IDs, see GET /v1alpha/reporting/reports.

Copy

cURL sample request: Retrieve a report's details

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/reporting/reports/a4e20e3d-8569-488b-be51-757d14bccb2f' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns a specific report's information such as title, description, owner, and the allowed actions you can take on the report. Use the returned link to direct users to the report; for example, link to the report in an embedded iframe.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "id": "a4e20e3d-8569-488b-be51-757d14bccb2f",
    "title": "Callisto report 2",
    "updatedTime": "1737159930073",
    "owner": "f3ab0a40-d12f-1c4e-97c9-12817ed96d9b",
    "isOwnedByUser": true,
    "allowedActions": [
        "duplicate",
        "delete",
        "edit",
        "download",
        "share"
    ],
    "link": "#/analytics/reporting/a4e20e3d-8569-488b-be51-757d14bccb2f"
}

Create a report

Use this sample request to create a new report with a title and description. To edit other contents of the report, such as columns and group bys, navigate to the Reports room in Visier. For more information, see Create a Report.

Copy

cURL sample request: Create a report

1
2
3
4
5
6
7
8
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1alpha/reporting/reports \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-H 'Content-Type: application/json' \
-d '{
    "title": "API Report",
    "description": "This is a description"
    }'

The response returns the created report's information such as unique ID, title, description, owner, and the allowed actions you can take on the report. Use the returned link to direct users to the report; for example, link to the report in an embedded iframe.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
    "id": "bbbdac69-6b22-4858-894f-2870b8c7318c",
    "title": "API Report",
    "description": "This is a description",
    "updatedTime": "1739312674753",
    "owner": "f3ab0a40-d12f-1c4e-97c9-12817ed96d9b",
    "isOwnedByUser": true,
    "allowedActions": [
        "duplicate",
        "delete",
        "edit",
        "download",
        "share"
    ],
    "link": "#/analytics/reporting/bbbdac69-6b22-4858-894f-2870b8c7318c"
}

Duplicate a report

Use this sample request to make a copy of an existing report. You must know the ID of the report to retrieve its details. To retrieve report IDs, see GET /v1alpha/reporting/reports.

Copy

cURL sample request: Duplicate a report

1
2
3
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1alpha/reporting/reports/bbbdac69-6b22-4858-894f-2870b8c7318c' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the duplicated report's information such as unique ID, title, description, owner, and the allowed actions you can take on the report. Use the returned link to direct users to the report; for example, link to the report in an embedded iframe.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "id": "a4e20e3d-8569-488b-be51-757d14bccb2f",
    "title": "Callisto report 2",
    "updatedTime": "1737159930073",
    "owner": "f3ab0a40-d12f-1c4e-97c9-12817ed96d9b",
    "isOwnedByUser": true,
    "allowedActions": [
        "duplicate",
        "delete",
        "edit",
        "download",
        "share"
    ],
    "link": "#/analytics/reporting/a4e20e3d-8569-488b-be51-757d14bccb2f"
}

Delete a report

Use this sample request to delete a report in the tenant.

Copy

cURL sample request: Delete a report

1
2
3
curl -X DELETE --url 'https://{vanity_name}.api.visier.io/v1alpha/reporting/reports/741899b6-a8a7-48a9-b841-19ba30da8aa3' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the ID of the deleted report.

View sample response

Copy

1
2
3
{
    "id": "741899b6-a8a7-48a9-b841-19ba30da8aa3"
}

Download a report

Use this sample request to download a report as a CSV file. The returned CSV file contains the data in the report. You must know the ID of the report to retrieve its details. To retrieve report IDs, see GET /v1alpha/reporting/reports.

Copy

cURL sample request: Download a report

1
2
3
4
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/reporting/report-data/b511f6c2-d981-40b8-a830-c537349579f9?' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-o ./test_report.csv

The response returns a CSV file that contains the data in the report, such as the columns and values.