Asset Validation

AI Tools

Overview

As a part of Campaign setup, asset source validation framework allows the user to validate the asset source data. The user should be notified with all the invalid rows in the asset source with a detailed listing of what is invalid. With this feature, the user is pre-informed of the invalid data coming in the feed, uploaded asset source or the asset sources created through the DCS.

Methods

Method Name	Method Type	Description
Trigger Validation Framework	GET	To trigger the asset validation for the data service id.
Get API to Download Report	GET	To get (download) the validation report.
Get API to view json	GET	To view the validation report.

Trigger Validation Framework

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.
dataServiceId	string	Mandatory	path	It is a unique identifier for asset sources.

Sample Request

GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/triggerValidation/:dataServiceId

Sample Response

{ "message": "IN_PROGRESS", "status": "202" }

In case the data service Id is not present in the database the response will be as shown below:

{ "timestamp": "2021-03-01T19:50:07.764+0000", "message": "Data Service Id Does Not Exist", "details": "uri=/validateAssetSource" }

Status code: 400

In case the data service Id is present in the database but the columns are not eligible for validation then the response will be as shown below:

{ "timestamp": "2021-03-01T19:50:07.764+0000", "message": "No column eligible for validation", "details": "uri=/validateAssetSource" }

Status code: 400

GET API to download Report

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.
dataServiceId	string	Mandatory	path	It is a unique identifier for asset sources.

Sample Request

GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/detailedReport/:dataServiceId/download

Sample Response

{ "presignedUrl": "https://xyz.com" "status": "INVALID", "statusCode": 200 }

Info

Reports are downloaded on the user's system.

If no report is available for a data serviceID then the following is the response:

{ "errorMsg": "No report present for this dataservice Id", "reason": "No report present for this dataservice Id", "statusCode": 400 }

GET API to view json

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.
dataServiceId	string	Mandatory	path

Sample Request

GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/detailedReport/:dataServiceId

Sample Response

1- If the validation framework status is “IN_PROGRESS" then the response is as below:

{ "presignedUrl": null "status": "IN_PROGRESS", "statusCode": 206 }

2- If the validation framework status is “VALID" then the response is as below:

{ "presignedUrl": null "status": "VALID", "statusCode": 202 }

3- If the validation framework status is “INVALID" then the response is as below:

{ "presignedUrl": Presigned Url / "Presigned url cannot be generated", "status": "INVALID", "statusCode": 200/ 400 }

4- If the validation framework status is “CANCELLED" or "FAILED"

{ "presignedUrl": null "status": "CANCELLED", "statusCode": 406 }

Last updated on

Was this page helpful?