CAMPAGNE / Campaigns.Get
Creazione e gestione delle campagne email
Recupera dalla console le informazioni relative ad una campagna
Esempio:
SessionID=yourSessionID&Command=Campaigns.Get &ResponseFormat=JSON& OrderField=yourValue& OrderType=yourValue& CampaignStatus=yourValue& SearchKeyowrd=yourValue& RecordsPerRequest=yourValue& RecordsFrom=yourValue
PARAMETRI RICHIESTA
Parametro | Tipo di dato | Richiesto | Definizione |
---|---|---|---|
SessionID | string | Session ID which is needed to authenticate the access. It's optional and required for desktop applications only | |
Command | string | The API Command sended to the console | |
ResponseFormat | JSON | XML | Response format | |
JSONPCallBack | bool | Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP | |
OrderField | string | Name of the field to order based on | |
OrderType | string | {ASC | DESC} - Type or ordering | |
CampaignStatus | string | {All | Draft | Ready | Sending | Paused | Pending Approval | Sent | Failed} - Status of campaigns to retrieve | |
SearchKeyowrd | string | Keyword to look for in CampaignName field | |
RecordsPerRequest | integer | How many rows to return per page | |
RecordsFrom | integer | Start from (starts from zero) | |
RetrieveTags | string | {true|false} -Set to true if you are going to filter campaign list based on specific filters | |
Tags | string | Tag ID numbers separated with comma if you are going to filter campaign list based on tags |
PARAMETRI DI RISPOSTA
Parametro | Tipo di dato | Definizione |
---|---|---|
Success | bool | States if an error has been generated during last command execution or not |
ErrorCode | integer | The ErrorCode number, if an error has occurred. ErrorCode = 0 means no error has occurred. |
ErrorText | string | Error description |
Campaigns | array | Returns the list of all campaigns in an array |
TotalCampaigns | integer | Returns the total number of campaigns |
CODICI DI ERRORE
Codice | Definizione |
---|---|
1 | Missing user ID |
99998 | Authentication failure or session expired |
99999 | Not enough privileges |