Skip to content

Commit

Permalink
bare minimum change to documentation (#50)
Browse files Browse the repository at this point in the history
i think this can read better with a few tweaks. i will open it up for discussion on the pr.
  • Loading branch information
bhenry authored Jan 8, 2024
1 parent b4db74c commit 88939af
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion api/external/response_exports.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h1>Response Exports<a class="headerlink" href="#response_exports" title="Permal
<tr class="field-odd field"><th class="field-name">Supported criteria:</th><td class="field-body"><ul class="first simple">
<li><strong>include_fields</strong> (<em>boolean, list of strings</em>) &#8211; <strong>Defaults to false.</strong> If <tt class="docutils literal"><span class="pre"></span>true</span></tt>, export will include all member fields in the account. If list of strings, export will include all member fields by <tt class="docutils literal"><span class="pre"></span>shortcut_name</span></tt> that exist in the account.</li>
<li><strong>mailing_ids</strong> (<em>array of integers</em>) - <strong>Defaults to empty list.</strong> If no <tt class="docutils literal"><span class="pre"></span>mailing_ids</span></tt> are specified, the last 50 mailings ordered by <tt class="docutils literal"><span class="pre"></span>send_started</span></tt> (most recently sent mailings) will be included in the export. The maximum number of <tt class="docutils literal"><span class="pre"></span>mailing_ids</span></tt> supported is 50.</li>
<li><strong>from_date</strong> (<em>datetime</em>) - <strong>Defaults to none.</strong> Exports response data starting from the date specified, and cannot be farther back than the previous 18 months. If paired with <tt class="docutils literal"><span class="pre">to_date</span></tt>, the export will be rejected if the total time period is greater than 90 days.</li>
<li><strong>from_date</strong> (<em>datetime</em>) - <strong>Defaults to none.</strong> Exports response data starting from the date specified, and cannot be farther back than the previous 18 months. If paired with <tt class="docutils literal"><span class="pre">to_date</span></tt>, the export will be rejected if the total time period is greater than 90 days. If <tt class="docutils literal"><span class="pre">mailing_ids</span></tt> are provided, the time period is not restricted.</li>
<li><strong>to_date</strong> (<em>datetime</em>) - <strong>Defaults to none.</strong> Limits the response data exported up to the specified date. If paired with <tt class="docutils literal"><span class="pre"></span>from_date</span></tt>, the export will be rejected if the total time period is greater than 90 days.</li>
</ul>
</td>
Expand Down

0 comments on commit 88939af

Please sign in to comment.