Skip to content

Commit

Permalink
DNC Complaints API endpoint - corrected line breaks and misc. typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
rc100 committed Apr 20, 2020
1 parent f094aff commit dc2e850
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/endpoint-dnc-complaints.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ _(none)_
| :--- | :--- | :--- |
| `api_key` | _(string)_ | _Required (unless provided in X-Api-Key header field)._ A valid api.data.gov API key. You can request an API key at [API Key Signup Form](https://api.data.gov/signup). |
| `created_date` | _(string)_ | _Optional._ Filter records by a specific date that complaints were created during.<br /><br />For example, show all complaints created on February 26, 2020:<br />_Example:_ `?created_date="2020-02-26"`<br /><br />Note: Date value must be enclosed in double-quotes. |
| `created_date_from<br />created_date_to` | _(string)_ | _Optional._ Filter records by a range of dates/times that complaints were created. These filters must be used together. Can be combined with any one these filters: `state`, `area_code`, or `is_robocall`. When combined with the `state` filter, an optional `city` filter can be added.<br /><br />For example, show all complaints created between February 26, 2020 and February 27, 2020:<br />`?created_date_from="2020-02-26"&created_date_to="2020-02-27"`<br /><br />Note: Date/time values must be enclosed in double-quotes. If only date values are provided, data will be filtered from midnight on `created_date_from` to 11:59:59pm on `created_date_to`. Time values can be specified using ISO-8601 format: "YYYY-MM-DD HH:MM:SS".|
| `created_date_from`<br />`created_date_to` | _(string)_ | _Optional._ Filter records by a range of dates/times that complaints were created. These filters must be used together. Can be combined with any one these filters: `state`, `area_code`, or `is_robocall`. When combined with the `state` filter, an optional `city` filter can be added.<br /><br />For example, show all complaints created between February 26, 2020 and February 27, 2020:<br />`?created_date_from="2020-02-26"&created_date_to="2020-02-27"`<br /><br />Note: Date/time values must be enclosed in double-quotes. If only date values are provided, data will be filtered from midnight on `created_date_from` to 11:59:59pm on `created_date_to`. Time values can be specified using ISO-8601 format: "YYYY-MM-DD HH:MM:SS".|
| `violation_date` | _(string)_ | _Optional._ Filter records by a specific date that unwanted calls were received during.<br /><br />For example, show all unwanted calls received on February 26, 2020:<br />`?violation_date="2020-02-26"`<br /><br />Note: Date value must be enclosed in double-quotes.|
| `violation_date_from<br />violation_date_to` | _(string)_ | _Optional._ Filter records by a range of dates/times that unwanted calls were received during.<br /><br />For example, show all unwanted calls received between February 26, 2020 and February 27, 2020:<br />`?violation_date_from="2020-02-26"&violation_date_to="2020-02-27"`<br /><br />Note: Date/time values must be enclosed in double-quotes. If only date values are provided, data will be filtered from midnight on `violation_date_from` to 11:59:59pm on `violation_date_to`. Time values can be specified using ISO-8601 format: "YYYY-MM-DD HH:MM:SS".|
| `violation_date_from`<br />`violation_date_to` | _(string)_ | _Optional._ Filter records by a range of dates/times that unwanted calls were received during.<br /><br />For example, show all unwanted calls received between February 26, 2020 and February 27, 2020:<br />`?violation_date_from="2020-02-26"&violation_date_to="2020-02-27"`<br /><br />Note: Date/time values must be enclosed in double-quotes. If only date values are provided, data will be filtered from midnight on `violation_date_from` to 11:59:59pm on `violation_date_to`. Time values can be specified using ISO-8601 format: "YYYY-MM-DD HH:MM:SS".|
| `state` | _(string)_ | _Optional._ Filter records by a state that complaints originated from. Can be combined with the `city` and `created_date_from` / `created_date_to` filters.<br /><br />For example, show all complaints originating from Idaho:<br />`?state="Idaho"`<br /><br />Note: Value that include spaces must be enclosed in double-quotes.|
| `city` | _(string)_ | _Optional._ Filter records by a city that complaints originated from. This filter must be used together with the `state` filter. Can be combined with the `created_date_from` / `created_date_to` filters.<br /><br />For example, show all complaints originating from Phoenix, Arizona:<br />`?state="Arizona"&city="Phoenix"`<br /><br />Note: Value that include spaces must be enclosed in double-quotes.|
| `area_code` | _(integer)_ | _Optional._ Filter records by the area code that complaints originated from. Can be combined with the `created_date_from` / `created_date_to` filters.<br /><br />For example, show all complaints originating from the 360 area code:<br />`?area_code=360`|
| `is_robocall` | _(string)_ | _Optional._ Filter by whether the unwanted call was a recorded message / robocall or not. Value must be either "true" or "false". Can be combined with the `created_date_from` / `created_date_to` filters.<br /><br />For example, only show complaints that were recorded messages / robocalls:<br />`?is_robocall=true`|
| `sort_order` | _(string)_ | _Optional._ Sort direction to use with the sort_by parameter.<br />DESC = Sort in descending order (default)<br />ASC = Sort in ascending order.<br />Example: `?sort_order=`|
| `sort_order` | _(string)_ | _Optional._ Sort direction to use with the sort_by parameter.<br />DESC = Sort in descending order (default)<br />ASC = Sort in ascending order.<br />Example: `?sort_order=ASC`|
| `items_per_page` | _(integer)_ | _Optional._ Maximum number of records to include in JSON response. By default, the endpoint displays a maximum of 50 records per request - this is also the maximum value allowed. All non-empty responses include pagination metadata, which can be used to iterate over a large number of records, by sending a GET request for each page of records.<br />Example: `?items_per_page=10` |
| `offset` | _(integer)_ | _Optional._ Offset by a number of records, allowing a particular section of paginated results to be requested (use with the items_per_page parameter).<br />Example: `?offset=10` |

Expand Down Expand Up @@ -139,7 +139,7 @@ All responses are in JSON format. The JSON object structure loosely adheres to t

### Example

List DNC Complaints for ID = "2dae54c3d3c06d1960689139d39c3138" :
List DNC Complaints for ID = "2dae54c3d3c06d1960689139d39c3138" :
[https://api.ftc.gov/v0/dnc-complaints/2dae54c3d3c06d1960689139d39c3138?api_key=DEMO_KEY](https://api.ftc.gov/v0/dnc-complaints/2dae54c3d3c06d1960689139d39c3138?api_key=DEMO_KEY)

<pre>
Expand Down Expand Up @@ -198,8 +198,6 @@ List DNC Complaints for ID = "2dae54c3d3c06d1960689139d39c3138" :
| \|- `links` | _(object)_ | An object containing links pertaining to this record. |
| \|---- `self` | _(url)_ | The URL for this record. |
| `meta` | _(object)_ | An object containing metadata for the request itself, including pagination data. |
| \|- `page` | _(string)_ | The page number for the list of records in this response. |
| \|- `pages-total` | _(string)_ | The total number of result pages for the request. |
| \|- `records-this-page` | _(string)_ | The number of records included in this response. |
| \|- `records-total` | _(string)_ | The total number of records found for the request. |
| `links` | _(object)_ | An object containing links pertaining to the request itself. |
Expand Down

0 comments on commit dc2e850

Please sign in to comment.