-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathCustomer API Data Reference: Test Set.html
executable file
·70 lines (70 loc) · 14 KB
/
Customer API Data Reference: Test Set.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<!-- page=Customer API Data Reference: Test Set -->
<!-- uid=ff2919e5375a25561a1b0309484689f8bcc5a557 -->
<!-- time=1360346395 -->
<!-- ip=66.134.198.26 -->
<!-- content-type=text/html -->
<!-- name=Brendan Caffrey -->
<!-- [email protected] -->
<h1 style="font-weight:bold;font-style:inherit;font-size:20px;font-family:'Segoe UI', 'Lucida Grande', Arial, sans-serif;vertical-align:baseline;line-height:1.25em;color:#434343;padding:0px;margin:0px;border:0px;"><a style="font-weight:inherit;font-style:inherit;font-size:20px;font-family:inherit;vertical-align:baseline;color:#114488;text-decoration:underline !important;padding:0px;margin:0px;border:0px;" href="http://docs.litmus.com/Customer-API-documentation" search_id="undefined">Back to Customer API documentation</a></h1>
<h2 style="font-weight:bold;font-style:inherit;font-size:17px;font-family:'Segoe UI', 'Lucida Grande', Arial, sans-serif;vertical-align:baseline;font:normal normal bold 20px/normal Arial;line-height:1.25em;color:#444444;padding:0px;margin:0px;border:0px;"> </h2>
<h2 style="font-weight:bold;font-style:inherit;font-size:17px;font-family:'Segoe UI', 'Lucida Grande', Arial, sans-serif;vertical-align:baseline;font:normal normal bold 20px/normal Arial;line-height:1.25em;color:#444444;padding:0px;margin:0px;border:0px;">Data Reference: Test Set</h2>
<p> </p>
<p id="created_at" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>created_at</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>date/time</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The XML formatted time at which this test was created in Litmus</p>
<p> </p>
<p> </p>
<p id="updated_at" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>updated_at</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>date/time</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The XML formatted time at which this test was last updated in Litmus</p>
<p> </p>
<p> </p>
<p id="id" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>id</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>integer</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p>The identifier assigned to this test.</p>
<p> </p>
<p> </p>
<p id="name" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>name</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>string</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-write</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The name that appears next to this test in the Litmus web interface. By default, for page tests this is set to the page title, for email tests it is set to the email subject line. This can be changed by <a href="Customer-API-Documentation%3A-tests-update">updating a test</a> once it has been created.</p>
<p> </p>
<p> </p>
<p id="service" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>service</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>string</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The testing service used to generate this test. At the moment this will only return <em>page</em> or <em>email</em> as these are the only services currently offered.</p>
<p> </p>
<p> </p>
<p id="state" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>state</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>string</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The overall state of this test. This is here for convenience and will indicate the state of the most recent test set version. If you create a new version of an existing test then this will change back to the processing state. Valid values for this parameter are: <em>complete</em>, <em>processing</em> and for email tests that have not been received by Litmus yet: <em>waiting</em></p>
<p> </p>
<p> </p>
<p id="public_sharing" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>public_sharing</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>boolean</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-write</em> </p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">Indicates whether this test is shared publicly. When set to true then a <em>public_path</em> parameter will also be set and indicate the url needed to access the tests via the public interface. This parameter can be set by <a style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;color:#114488 !important;padding:0px;margin:0px;border:0px;" href="Customer-API-Documentation%3A-tests-update">updating a test</a> once it has been created. If you want to generate a new <em>public_path</em> (perhaps the old one was accidentally leaked) you can switch <em>public_sharing</em> off and on again and it will generate a new url.</p>
<p> </p>
<p> </p>
<p id="public_path" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>public_path</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>string</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The full url to access this test set publicly hosted on the Litmus web interface. Will use https if the account has SSL and it is enabled.</p>
<p> </p>
<p> </p>
<p id="url_or_guid" style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Parameter:</strong> <em>url_or_guid</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>Type:</strong> <em>string</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;"><strong>RO/RW: </strong> <em>read-only</em></p>
<p style="font-weight:inherit;font-style:inherit;font-size:13px;font-family:inherit;vertical-align:baseline;line-height:1.5em;padding:0px;margin:0px;border:0px;">The url of the page being tested if this is a page test, for email tests it is the email address to send the test. This is specified as a convenience accessor to the most recent test version. Normally the page url won't change between versions, but each new email test generates a new guid.</p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<!-- pbraw=eJztmm1v2zYQx9/7U3AetmxAbMd2nCaKGyxtsSFAthVNtu5dcJJOFjeZFEjKjvfpd0fKT0HSOlkK1IGbwg+URfKOdz/+SaqEEUZvK+v0GI04f38h3oED8QEzNKgSjMQ1Wieu0DUqmUZZ1jvpnuCg/2oAvcHgqAvd+KB/cHJ4fHh0fJIdx0kygMHgVcPJMUbd/tFB//CofzJoyDI6Omp3+4ft7slxu3fUSLRyqFzLzUqMHN66Tu7GRUMB3feGmk5BibeQZQZnDRyDLKI4lP5USDeuLJRlO9HjBt/VmkgzkipSutFqtYIFP+ui0FMrqKAxzLvCulmBr5sZNduaohzlLop1kZ76An8xkipHI11dJP/FqHdQ3oavGYxlMYv2rnCkUfxxsbcv9i6rRKYgfjGgUqSCcyOh2BcWlG1Zqik7naBxMoGiBYUcqSgGi4VUeMovrTz0otvuDXB8muhCm+jbwz7/nZaQplKNIm5/DN44/hhrk6LxH5tnQ7jPqHUjNrVr/pOHOlz3rts9PDw+PuXhaqWYaANOahVVZL/h34lv5LjUxoFym5ggcoPZ62buXBl1OqlObDsMLo9sZx6VLYrKFl2sxhQvvsGmsAgmyW9k+rrJjWfUdto8ewPJP8JpsRbPa3cOO3A27OTdM4qJ3tNiovvqy8QEV0kRbMZQiPqNOyN4rDp1ga/tU9Hj/20UPd+r2Jan5IvezhcPIa/2TrlwVsnfBEddYhAcpjfgmk/Owm7/kVm4bizbuhEnrDNajc7egyG4OiofduqiYFd4FfXbEMdnS+uGHfo6N3xLDL3mKeWTNn7+jb2Qkg86PJFtoxM+/N758DFaNf7Tr3O7193GbqBYSFtaFbNtcsN1juKvXy9FxrBwFMuCB1KAE9NcJrlwubTCcZ5PwYo63oVU4tJPQLWV64l/DwaqMn2ZGFgO/9LEbRr/HQt2LHgaCwqgD3XQPx4IMn2xIJDpNg36cwNA0nJ1hGYbXfCF09/nl0xpiSUzSYsusJY6z1mml6nV3jSBeAPgxaYQG7eNEfRcSUQVUJPb6IFnzqEp9XSrIoFznKOXMprmTShLBGOFwlu3luY8YTr6aZg0xRRjweA0GSTYFm9mIsUMqsLt82QsShihv82GGui/xbpCrK9KV2D4td8FrH8u3Z0fh4u2iv/GxAm2sS2uuc4ElIhRJDmoETEpnokh1PtO6ztM71b3ib7rn7d8S62gBJpBBpOXBPgu8EaS0CpB7kpOsiFGVPN1xMaws2gmMnm5vKvt26ZA3yFvt2pYEI8znXO+jmNR2SBrRqjQUKav6Btx7jyIxpohEi5MZVEItlsYdJVRfm+Nseb9EPxDYONSz6+VYmAkoqVVikFfr6+m7gdRrTKGmqEinfG25SOQ4xhnX7vznwwctm6bomyHmx1uFrjRVCUQMnwUU2av4uW6FkjUNno5lGg1QSX5xEKASgNspEqpSy4gY6Ua5hKpM4OJhxMrNRZP1J4ltdMWF5mY6arWLyRxFE7nF7kC0lB4KwML/c1Uo1phXFBXIq7P37x6M5pAZT09uR9t8Sf5KRUTKCoCGFvg7y/nGc6ki8Lpgx6XBdZ5vB+guahtlZFk9V1h6OVpDhNSq9oFUcZGy0nQfrUunaELTU1Bujv58lmCllVcyOTG5sCp9sJQGry9ZuE2ZdFz4zTWukBQ2+iCL7ZiXc+Ir9wbFzUQCVQ5EpfM6lqVVpAU4kSGEPDFrC0+Mtjm60pTYSAdLJ1R50YJLvfeWAGYRyEUVvOCk+tgQK0RuTIFoRXToCIhYab5CwFeEwmBnb6N1ZXz9Toq60UttRE6Fs/qDj79kZBHj8faIyFPe/Dj/y7AawX90Co8XK6ntikotybdwyR375D+UKLJoQxDw88daIX+bIBGzG900iQ9EwSGfzD9MUycNCB2Kl2SPwRQFuo+IGhGhRFIFaLDhai50yuKk40F/UrvX9hc9HDSbQl8duJ+J+4X4j6rKM95Algl/3wq4tliPgmJnKQ6elA8vJX6kalRWRT88BwtDILIp3p1pQIKr64u54ihVlBBXDxim4A6eqPNzah6wQeaKzZuUzDtqLKjyoIqDJR6he/PS2Kcr9H56YVsca4Cy8OWh05Tlsco1LbxfNIEJkLIXKEudyFsiQmf9qaCVdH6XoRnGy/v9f0bD4tNh9/8g5wEvEXv2ZqpVntusaOAbsqSrr7H7ou4cgKBdBbrpKURCwVlawnFWb0J7Z707T95MuE6 -->