list_campaigns: list_campaigns

Description Usage Arguments Details Author(s) See Also Examples

View source: R/campaigns.R

Description

List or search available campaigns

Usage

1
2
3
4
5
list_campaigns(type = "basic", key = getOption("microworkers_key"))

search_campaigns(status, folder, created_from, created_to,
                 restarted_from, restarted_to, finished_from, finished_to,
                 type = "basic", key = getOption("microworkers_key"))

Arguments

status

An optional character string containing a status. Must be one of: “BLOCKED”, “PENDING_REVIEW”, “PENDING_RESTART”, “PAUSED”, “PAUSED_ADMIN”, “RUNNING”, “PAUSED_SYSTEM”, or “FINISHED”.

folder

An optional character string containing a folder. Must be one of: “DEFAULT” or “ARCHIVE”.

created_from

An optional character string specifying a date, of the form: 2014-12-02 00:00:00.

created_to

An optional character string specifying a date, of the form: 2014-12-02 00:00:00.

restarted_from

An optional character string specifying a date, of the form: 2014-12-02 00:00:00.

restarted_to

An optional character string specifying a date, of the form: 2014-12-02 00:00:00.

finished_from

An optional character string specifying a date, of the form: 2014-12-02 00:00:00.

finished_to

An optional character string specifying a date, of the form: 2014-12-02 00:00:00.

type

A character string specifying the type of campaign. One of “basic” (the default) or “hiregroup”.

key

A character string containing a Microworkers.com API secret key.

Details

list_campaigns list campaigns of the specified type and their current status. search_campaigns does the same, but returns only those campaigns that satisfy the specified search criteria.

Author(s)

Thomas J. Leeper

See Also

basic_campaign hiregroup_campaign get_campaign get_results

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
list_campaigns()

## End(Not run)
## Not run: 
search_campaigns(status = "RUNNING")

search_campaigns(created_from = "2015-01-01 00:00:00", created_to = "2015-02-01 00:00:00")

## End(Not run)

cloudyr/microworkers documentation built on May 13, 2019, 8:21 p.m.