Newsman API Page
Listare API Newsman
List |
|
| Metoda | Descriere |
|---|---|
| getProps | Returns a hash array with the properties of a list |
| updateProps | Updates the properties of a list |
| updateProp | Updates one property of a list |
| getProp | Returns the property specified of a list |
| all | Returns a hash array with all available lists |
| count | Returns the number of active subscribers from a list |
| updateName | Updates a list name |
| getModerators | Returns an array with the moderator emails of this list (one email per array item) |
| setModerators | Replaces the moderators of a list with new moderators |
| getIps | Returns a list with the assigned IPs (one IP address per array item) |
| getSubscribers | Returns the subscribers matching status and since (optional) for a list. |
| getSubscriberVariables | Returns the custom variables for the subscribers of a list. |
| refreshSubscriberVariables | Refreshes the custom variables for the subscribers of a list. |
| subscribersHistory | Returns an array with the history entries for the subscribers of a list |
Newsletter |
|
| Metoda | Descriere |
| getProps | Returns a hash array with the properties of a newsletter |
| getProp | Returns a property of a newsletter (saved before) |
| updateProps | Updates the properties of a newsletter |
| updateProp | Updates a property of a newsletter |
| pause | Pauses a sending newsletter |
| resume | Resumes a paused newsletter |
| schedule | Schedules a newsletter to be sent in the future |
| cancel | Cancels a newsletter |
| confirm | Confirms a newsletter via API |
| sendConfirm | Sends a newsletter confirmation mail |
| create | Creates a new newsletter in this list |
| getSegments | Returns an array with the current destination segments |
| setSegments | Updates the destination segments of this newsletter |
| setAlternateContent | Sets the alternate content for a newsletter (viewable online at ##NEWSMAN:view_online##?akey= |
| all | Returns a list of newsletters with status $status between $start_date, $stop_date (inclusive) |
| update | Updates a newsletter (unconfirmed only) |
| sendTest | Sends a test to the specified emails |
| stats | Returns stats for the specified newsletter |
| linksClicked | Returns links clicked for the specified newsletter |
| restart | Restarts a sent newsletter |
| subscribersHistory | Returns an array with the history entries for the subscribers of a newsletter |
Segment |
|
| Metoda | Descriere |
| all | Returns a hash array with all available segments for a list the return status of a segment is: 0 – no operations running, 1 – import running, 2 – subscriber number is being calculated, 3 – a search is being performed |
| search | Returns a hash array with all available segments for a list found for the search regex the return status of a segment is: 0 – no operations running, 1 – import running, 2 – subscriber number is being calculated, 3 – a search is being performed |
| count | Returns the number of active subscribers from a segment |
| updateName | Updates a segment name |
| delete | Removes a segment from the database |
| addSubscriber | Ads a subscriber to the segment |
| removeSubscriber | Removes a subscriber from a segment |
| create | Creates a new segment for a list |
| clear | Removes all subscribers from this segment |
| refresh | Updates the subscribers in the segment |
| getSubscribers | Returns the subscribers matching status and since (optional) for a list. |
| massUnsubscribe | Unsubscribes all subscribers in a segment |
| massDeactivate | Deactivates all subscribers in a segment |
Subscriber |
|
| Metoda | Descriere |
| get | Returns subscriber data as hash (struct) array |
| getByEmail | Returns subscriber data as hash (struct) array |
| history | Returns subscriber action history (last 30 actions) as struct (array with history entries) |
| update | Updates email, firstname or lastname for a subscriber |
| updateProps | Update subscriber props. |
| updateProp | Updates a subscriber property |
| addToSegment | Ads a subscriber to a specific segment |
| removeFromSegment | Removes a subscriber from a segment |
| saveSubscribe | Saves / subscribes a subscriber to the list |
| initSubscribe | Inits a confirmed opt in subscribe. Email is sent first to the subscriber with an unique link which has to be clicked. |
| saveUnsubscribe | Unsubscribes an email from a list |
| initUnsubscribe | Inits a unsubscribe request. Email with unsubscribe confirmation link is sent to the subscriber |
| getProfilingAllowed | Gets if profiling is allowed or not for a subscriber |
| setProfilingAllowed | Sets if profiling is allowed or not for a subscriber |
| search | Returns the subscribers matching keywords, status and since (optional) for a list. |
Template |
|
| Metoda | Descriere |
| mailTemplateAdd | Ads a transactional mail template for this list. Later can be used in initSubscribe and initUnsubscribe. |
| mailTemplateDel | Deletes a mail template for this user |
| mailTemplateUpdate | Updates a transactional mail template for this list. |
| mailTemplateGet | Returns the content of this template as hash array for this $template_id |
| mailTemplateSearch | Returns a list of template_ids for this list and this type |
Download |
|
| Metoda | Descriere |
| subscribed | Returns a download link to a CSV file, valid for 1h, from your current IP with the subscribed users of this list. |
| unsubscribed | Returns a download link to a CSV file, valid for 1h, from your current IP with the users who unsubcribed from newsletters unsubscribe links. |
| unsubscribed_all | Returns a download link to a CSV file, valid for 1h, from your current IP with all the unsubscribers users in this list, regardless of unsubscribe method. |
| bounced | Returns a download link to a CSV file, valid for 1h, from your current IP with the bounced users of this list. |
| reported_spam | Returns a download link to a CSV file, valid for 1h, from your current IP with the users of this list which reported newsletters as spam. |
| segment | Returns a download link to a CSV file, valid for 1h, from your current IP with the subscribed users of this list segment. |
| search | Returns a download link to a CSV file with users matching your search criteria from this list. |
| newsletterSent | Returns a download link to a CSV file, valid for 1h, from your current IP with the users which received this newsletter. |
| newsletterViewed | Returns a download link to a CSV file, valid for 1h, from your current IP with the users which viewed this newsletter. |
| newsletterClicked | Returns a download link to a CSV file, valid for 1h, from your current IP with the users which clicked this newsletter. |
| newsletterUnsubscribes | Returns a download link to a CSV file, valid for 1h, from your current IP with the users which unsubscribed from this newsletter. |
| newsletterReportedSpam | Returns a download link to a CSV file, valid for 1h, from your current IP with the users which Reported Spam from this newsletter. |
| newsletterBounced | Returns a download link to a CSV file, valid for 1h, from your current IP with the users which Bounced from this newsletter. |
Import |
|
| Metoda | Descriere |
| csv | Creates a task to import users from csv file (data in $csv_data) into the database. Import will run in background. |
| status | Retrieves the status of import by ID. |
Abtest |
|
| Metoda | Descriere |
| createVariant | Creates a newsletter variant (part of AB Test). |
| setTestProps | Updates the AB Test properties |
| getTestProps | Returns the current Newsletter AB Test properties |
| getVariantsIds | Returns an array with the variants ids |
| getVariant | Returns specific variant of this test |
| deleteVariant | Deletes a test variant |
| setWinner | Sets a TEST winner |
