1. Login
To log in - the general login API is used. Example - Login API
This step is for getting a Token to add to the request header for Authentication reasons.
2. Create a report with bucket scheduling:
Request URL:
https://manage.aniview.com/api/adserver/report?format=json
To read more about all the metrics and dimension and the call in general visit: Reporting API
Request Method:
GET
Headers:
{ Content-Type: application/json,
X-Bamboo-Token: "<your_Auth_Token>" }
Body:
in the scheduling object, there is the integration, integration.type will indicate if it is a type email or bucket and if it is integrated.bucket object will contain the integration of your bucket
"scheduling": {
"startDate": 1724198400000,
"endDate": 1755734400000,
"isScheduled": true,
"startHour": "10",
"intervalHours": 2,
"weekDay": 1,
"monthDay": 1,
"integration": {
"type": 2,
"bucket": {
"bucketName": "xxxxxxxxxxxxxxxxx",
"accessKey": "xxxxxxxxxxxxxxxxx",
"secretKey": "xxxxxxxxxxxxxxxxx"
}
}
{
"name": "new report",
"type": 1,
"privacy": 0,
"cb": false,
"async": true,
"includeHeaders": true,
"collection": "",
"igq": false,
"drm": false,
"selectedDb": false,
"dimensions": {
"values": []
},
"metrics": {
"values": [
"inventory",
"request",
"bid",
"impression",
"revenue",
"totalCost"
]
},
"filter": {
"additionalFilters": [],
"requestStartDate": null,
"requestEndDate": null,
"startDate": 1724198400,
"endDate": 1724284799
},
"recipients": {
"values": []
},
"frequency": "weekly",
"scheduling": {
"startDate": 1724198400000,
"endDate": 1755734400000,
"isScheduled": true,
"startHour": "10",
"intervalHours": 2,
"weekDay": 1,
"monthDay": 1,
"integration": {
"type": 2,
"bucket": {
"bucketName": "xxxxxxxxxxxxxxxxx",
"accessKey": "xxxxxxxxxxxxxxxxx",
"secretKey": "xxxxxxxxxxxxxxxxx"
}
},
"dateRangeValue": null,
"type": "today"
},
"timezoneName": "UTC",
"timezoneOffset": 0
}
Response:
200 OK
{
"data": {
"id": null,
"_id": {
"$oid": "66c5ed84d000390dde0d6b7a"
},
"createdAt": {
"$date": {
"$numberLong": "1724247428000"
}
},
"updatedAt": {
"$date": {
"$numberLong": "1724247428000"
}
},
"iUpdatedAt": 1724247428,
"createdBy": "atara@aniview.com",
"updatedBy": "atara@aniview.com",
"status": 1,
"name": "qa report",
"description": null,
"publisherId": "565c56d3181f46bd608b459a",
"restoreFrom": null,
"lastAuditTrailId": null,
"type": 1,
"tppId": null,
"lastRunAt": null,
"lastScheduledRunAt": null,
"nextScheduledRunAt": {
"$date": {
"$numberLong": "1724666400000"
}
},
"startGenerationTime": null,
"dimensions": {
"values": []
},
"privacy": 0,
"threshold": 50,
"recipients": {
"values": []
},
"frequency": "weekly",
"scheduling": {
"startDate": {
"$date": {
"$numberLong": "1724198400000"
}
},
"endDate": {
"$date": {
"$numberLong": "1755734400000"
}
},
"type": "today",
"dateRangeValue": null,
"startHour": 10,
"isScheduled": true,
"integration": {
"type": 2,
"bucket": {
"bucketName": "xxxxxxxxxxxxxxxxx",
"accessKey": "xxxxxxxxxxxxxxxxx",
"secretKey": "xxxxxxxxxxxxxxxxx",
"path": null
}
},
"intervalHours": 2,
"weekDay": 1,
"monthDay": 1
},
"timezoneOffset": 0,
"timezoneName": "UTC",
"filter": {
"startDate": {
"$date": {
"$numberLong": "1724198400000"
}
},
"endDate": {
"$date": {
"$numberLong": "1724284799000"
}
},
"requestEndDate": null,
"requestStartDate": null,
"additionalFilters": []
},
"metrics": {
"values": [
"inventory",
"request",
"bid",
"impression",
"revenue",
"totalCost"
]
},
"socketAddress": null,
"collection": "",
"reportUrl": null,
"reportUrlV2": null,
"reportJsonFilename": null,
"reportJson": null,
"summaryReportJson": null,
"reportJsonSave": null,
"summaryReportId": null,
"statusV2": null,
"errorNew": null,
"keyParamsHash": null,
"reportDbAggregationLastRun": null,
"preGenerateStatus": null,
"preGenerateStatusV2": null,
"gzFile": null,
"startedGeneratingAt": null,
"finishedGeneratingAt": null,
"top": null,
"sort": null,
"pager": null,
"selectedDb": false,
"cb": false,
"aggregatedTill": null,
"reportOrigin": null,
"generateOrigin": null,
"compare": null,
"reportPublisherId": null,
"includeHeaders": true,
"roundResult": null,
"linkedEntities": null,
"utcTime": null,
"drm": false,
"totalSlotMs": null
}
}