Skip to content

Commit fed2a04

Browse files
committed
Saved README.md with Dillinger.io [skip ci]
1 parent 5e22419 commit fed2a04

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,19 @@ This will search for the most recent comments with the word science in the body
3232

3333
There are numerous additional parameters that can be used when performing a comment search. Let's go over each of them now and provide examples for each one.
3434

35-
| Parameter | Description | Default |
36-
| ------ | ------ | ------- |
37-
| q | Search term. | N/A |
38-
| size | Number of results to return | 25 |
39-
| fields | One return specific fields (comma delimited) | All Fields Returned
40-
| sort | Return results "asc" or "desc" | "desc" |
41-
| sort_type | Sort by a specific attribute | "created_utc" |
42-
| aggs | Return aggregation data (author, link_id, created_utc, subreddit) | N/A |
43-
| author | Restrict to a specific author | N/A |
44-
| subreddit | Restrict to a specific subreddit | N/A |
45-
| after | Return results after this date | N/A |
46-
| before | Return results before this date | N/A |
47-
| frequency | Used with the aggs parameter (second, minute, hour, day -- See below) | N/A |
35+
| Parameter | Description | Default | Accepted Values |
36+
| ------ | ------ | ------- | ------ |
37+
| q | Search term. | N/A | String / Quoted String for phrases |
38+
| size | Number of results to return | 25 | Integer < 500
39+
| fields | One return specific fields (comma delimited) | All Fields Returned | string or comma-delimited string
40+
| sort | Sort results in a specific order | "desc" | "asc", "desc"
41+
| sort_type | Sort by a specific attribute | "created_utc" | "score", "num_comments", "created_utc"
42+
| aggs | Return aggregation summary | N/A | ["author", "link_id", "created_utc", "subreddit"]
43+
| author | Restrict to a specific author | N/A | String
44+
| subreddit | Restrict to a specific subreddit | N/A | String
45+
| after | Return results after this date | N/A | Epoch value or Integer + "s,m,h,d" (i.e. 30d for 30 days)
46+
| before | Return results before this date | N/A | Epoch value or Integer + "s,m,h,d" (i.e. 30d for 30 days)
47+
| frequency | Used with the aggs parameter when set to created_utc | N/A | "second", "minute", "hour", "day"
4848

4949
## Using the subreddit parameter
5050

0 commit comments

Comments
 (0)