Anura Docs

Anura Reporting API - Interface Endpoints

The following Interface data endpoints are available in the current version of the Anura Reporting API.

Anura Reporting API - Interface Endpoints - Instances

The instances endpoint will allow you to retrieve, or search, instances associated with your Reporting API token.

Method URL
POST https://api.anura.io/v1/interface/instances

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
Optional Type Description Note
name string The name value to which results will be limited. Results are returned based on a broad match of the declared value.
all boolean Set false to exclude the "All Instances" result object. True by default.
page integer The page of results to be returned. Page 1 is returned by default.
limit integer The number of returned results. 20 results are returned by default. 1,000 results max.

Example Response

{
    "instances": [
        {
            "id": "All+Instances",
            "name": "All+Instances"
        },
        {
            "id": 1234567890,
            "name": "yourInstanceName"
        }
    ],
    "query": {
        "name": false,
        "all": true,
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Interface Endpoints - Sources

The sources endpoint will allow you to retrieve, or search, sources applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/interface/sources

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source value to which results will be limited. Results are returned based on a broad match of the declared value.
all boolean Set false to exclude the "All Sources" result. True by default.
page integer The page of results to be returned. Page 1 is returned by default.
limit integer The number of returned results. 20 results are returned by default. 1,000 results max.

Example Response

{
    "sources": [
        "All+Sources",
        "yourSourceTrackingId"
    ],
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "all": true,
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Interface Endpoints - Campaigns

The campaigns endpoint will allow you to retrieve, or search, campaigns applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/interface/campaigns

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited. Results are returned based on a broad match of the declared value.
all boolean Set false to exclude the "All Campaigns" result. True by default.
page integer The page of results to be returned. Page 1 is returned by default.
limit integer The number of returned results. 20 results are returned by default. 1,000 results max.

Example Response

{
    "campaigns": [
        "All+Campaigns",
        "yourCampaignTrackingId"
    ],
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "all": true,
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}