GET/AUDIENCE¶

Use this API to fetch a list of recently uploaded user data sets via a call to any of the User Data resource collectors, i.e., /audience, /audience/segment, /audience/attribute and /audience/opt-out. The return value is a JSON array of metadata that match the query criteria, in reverse chronological order of “createTime”. The table below lists URIs supported for querying.

URI	Description
GET /audience	Use this API to fetch a list of uploads so far today (UTC time).
GET /audience?state= ERROR&date=2017-06- 14T00:00:00Z	Use query parameters “state” and/or “date” to override the default behavior. “State” must be one of the values enumerated in the metadata section of User Data resources. “Date” must be the format in which most date times are represented within DataX, i.e., RFC 3339 compliant (e.g., 2017-06-14T00:00:00Z). This value will be used to filter results on “createTime”. Time portion is ignored. Possible values of state are: UPLOADING, PROCESSING, ACCEPTED, ACCEPTED_WITH_ERRORS, SERVER_ERROR, SUCCESS, ERROR. If an invalid state is passed, no filtering happens.

URI

Description

GET /audience

Use this API to fetch a list of uploads so far today (UTC time).

GET /audience?state= ERROR&date=2017-06- 14T00:00:00Z

Use query parameters “state” and/or “date” to override the default behavior. “State” must be one of the values enumerated in the metadata section of User Data resources. “Date” must be the format in which most date times are represented within DataX, i.e., RFC 3339 compliant (e.g., 2017-06-14T00:00:00Z). This value will be used to filter results on “createTime”. Time portion is ignored.

Possible values of state are: UPLOADING, PROCESSING, ACCEPTED, ACCEPTED_WITH_ERRORS, SERVER_ERROR, SUCCESS, ERROR.

If an invalid state is passed, no filtering happens.

Example¶

Request¶

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8 [
        {
        "resourceType" : "datax-audience",
        "resourceId"  : "130815T013759Z662589033",
        "description" : "user qualifications – daily bucket 05/19/2013",
        "createTime" : "2013-05-19T12:19:17Z",
        "links" : [
                {
                        "rel"  : "self",
                        "href":"https://datax.yahooapis.com/v1/link/s/mJF90HlzC0618PRm-"
                },
                {
                        "rel"   : "describes",
                        "href" : "https://datax.yahooapis.com/v1/link/5qMQo4h4c2zi-"
                }
        ],
        "status" : {
                "state" : "ACCEPTED_WITH_ERRORS",
                "lastUpdateTime" : "2013-19-05T12:22:17Z "
        },
        "extensions" : { "urnType" : "IXID",
        "view" : "INCREMENTAL",
        "links" : [
                {
                "rel"   : "https://datax.yahooapis.com/rels/taxonomy",
                "href" : "https://datax.yahooapis.com/v1/link/O3stRliZAT.G.oqiu-"
                },
                {
                "rel"   : "https://datax.yahooapis.com/rels/stats",
                "href" : "https://datax.yahooapis.com/v1/link/VJbGt6S0hiqECL_-"
                },
                {
                "rel"   : "https://datax.yahooapis.com/rels/errors",
                "href" : "https://datax.yahooapis.com/v1/link/CNcgHDamD2jqm.nx-"
                },
                {
                "rel"  : "https://datax.yahooapis.com/rels/retry/errors",
                "href" : "https://datax.yahooapis.com/v1/link/iy452ui0.22j521-"
                },
                {
                "rel"  : "https://datax.yahooapis.com/rels/errors",
                "href" : "https://datax.yahooapis.com/v1/link/yuwsdg98mndeklaew"
                }
            ]
        }
    }
]