API Reference (Feed)

Menu

• Requests
• Feed
  • Submit feed
  • Feed request status
  • Feed request result file download
  • Feed history
• Appendix

Feed

Using the feed API you will be able to update configurations you used to update using the import tab in the Feedvisor dashboard.

Back to menu

Requests

Submit feed request

Method

POST

URL

<Post-authentication Base URL>/{accountId}/feed

Parameters

Parameter	Type	Optional	Value	Description
fileType	String	Yes	XLSX, CSV	(default: XLSX)
importType	String	yes	CONFIGURATION / NON_COMPETITIVE_7/ AMAZON_ADVERTISING / CUSTOM_ATTRIBUTE	(default: CONFIGURATION)
importSubType	String	no	IMPORT_ALL CAMPAIGN_UPDATE (legacy) CAMPAIGN_OPTIMIZE (legacy) AD_GROUP_UPDATE (legacy)	Send ONLY when importing the AMAZON_ADVERTISING importType
fileName	String	no		name of the file you are importing
file	File	no		MultiPartFile

Headers

Authorization: Bearer <access token> (Same as described above)

Example response

{

    "requestId":<requestId>

}

Back to menu

Feed request status

Method

GET

URL

<Post-authentication Base URL>/{accountId}/feed/{requestId}

Parameters

Parameter	Type	Optional	Description
requestId			requestId (integer)

Headers

Authorization: Bearer <access token> (Same as described above)

Example response

{

    "requestId":"123",

    "status":<Status>,

    "errorMessage":<errorMessage>,

    ”accountId”:123,

    ”lastUpdateDate”: <java timestamp>

}

Statuss:

Awaiting, //did not run yet

Queued, //did not run yet

InProgress, //running

Finished,// finished successfully

Canceled, //canceled by monitoring service if velocity is too low

Failed //request finished with failure

errorMessage: if the process fails, you will have an error message with info why it failed

Back to menu

Feed request result file download

Method

GET

URL

<Post-authentication Base URL>/{accountId}/feed/{requestId}/result_file

Parameters

Parameter	Type	Optional	Description
requestId		No	requestId (integer)
accountId		No	accountId (integer)

Headers

Authorization: Bearer <access token> (Same as described above)

Response

The response is the file itself

Char encoding: UTF-8

Headers:

Content-Disposition: attachment;filename=<filename>

Content-Type: text/csv;charset=UTF-8

Body:

byte[] of file

Back to menu

Feed history

Method

GET

URL

<Post-authentication Base URL>/{accountId}/feed/

Parameters

Parameter	Type	Optional	Description
count		yes	number of items to return (integer, default: 5)

Headers

Authorization: Bearer <access token> (Same as described above)

Example response

[

    {"requestId":"123","status":<status>,"errorMessage":"",”accountId”:123,”lastUpdateDate”: <java timestamp>},

    {"requestId":"124","status":<status>,"errorMessage":"",”accountId”:123,”lastUpdateDate”: <java timestamp>}

]

 

Back to menu

Click here to sample code & error handling 

Click here to API Requests