Skip to content

Commit 1d838bd

Browse files
authored
docs: reorganize examples (#360)
1 parent 1eb78b1 commit 1d838bd

5 files changed

+114
-91
lines changed

examples/categories/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
2+
3+
This folder contains various examples on using the Categories endpoint of SendGrid with Java:
4+
5+
* [Retrieve all categories (GET /categories)](RetrieveAllCategories.java)
6+
* [Retrieve Email Statistics for Categories (GET /categories/stats)](RetrieveStatisticsForCategories.java)
7+
* [Retrieve sums of email stats for each category (GET /categories/stats/sums)](RetrieveSumsForCategories.java)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import com.fasterxml.jackson.databind.JsonNode;
2+
import com.fasterxml.jackson.databind.ObjectMapper;
3+
4+
import com.sendgrid.*;
5+
6+
import java.io.IOException;
7+
import java.util.HashMap;
8+
import java.util.Map;
9+
10+
//////////////////////////////////////////////////////////////////
11+
// Retrieve all categories
12+
// GET /categories
13+
14+
15+
public class RetrieveAllCategories {
16+
public static void main(String[] args) throws IOException {
17+
try {
18+
SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
19+
Request request = new Request();
20+
request.setMethod(Method.GET);
21+
request.setEndpoint("categories");
22+
request.addQueryParam("category", "test_string");
23+
request.addQueryParam("limit", "1");
24+
request.addQueryParam("offset", "1");
25+
Response response = sg.api(request);
26+
System.out.println(response.getStatusCode());
27+
System.out.println(response.getBody());
28+
System.out.println(response.getHeaders());
29+
} catch (IOException ex) {
30+
throw ex;
31+
}
32+
}
33+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import com.fasterxml.jackson.databind.JsonNode;
2+
import com.fasterxml.jackson.databind.ObjectMapper;
3+
4+
import com.sendgrid.*;
5+
6+
import java.io.IOException;
7+
import java.util.HashMap;
8+
import java.util.Map;
9+
10+
//////////////////////////////////////////////////////////////////
11+
// Retrieve Email Statistics for Categories
12+
// GET /categories/stats
13+
14+
15+
public class RetrieveMailStatisticsForCategories {
16+
public static void main(String[] args) throws IOException {
17+
try {
18+
SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
19+
Request request = new Request();
20+
request.setMethod(Method.GET);
21+
request.setEndpoint("categories/stats");
22+
request.addQueryParam("end_date", "2016-04-01");
23+
request.addQueryParam("aggregated_by", "day");
24+
request.addQueryParam("limit", "1");
25+
request.addQueryParam("offset", "1");
26+
request.addQueryParam("start_date", "2016-01-01");
27+
request.addQueryParam("categories", "test_string");
28+
Response response = sg.api(request);
29+
System.out.println(response.getStatusCode());
30+
System.out.println(response.getBody());
31+
System.out.println(response.getHeaders());
32+
} catch (IOException ex) {
33+
throw ex;
34+
}
35+
}
36+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import com.fasterxml.jackson.databind.JsonNode;
2+
import com.fasterxml.jackson.databind.ObjectMapper;
3+
4+
import com.sendgrid.*;
5+
6+
import java.io.IOException;
7+
import java.util.HashMap;
8+
import java.util.Map;
9+
10+
//////////////////////////////////////////////////////////////////
11+
// Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]
12+
// GET /categories/stats/sums
13+
14+
15+
public class RetrieveSumsForCategories {
16+
public static void main(String[] args) throws IOException {
17+
try {
18+
SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
19+
Request request = new Request();
20+
request.setMethod(Method.GET);
21+
request.setEndpoint("categories/stats/sums");
22+
request.addQueryParam("end_date", "2016-04-01");
23+
request.addQueryParam("aggregated_by", "day");
24+
request.addQueryParam("limit", "1");
25+
request.addQueryParam("sort_by_metric", "test_string");
26+
request.addQueryParam("offset", "1");
27+
request.addQueryParam("start_date", "2016-01-01");
28+
request.addQueryParam("sort_by_direction", "asc");
29+
Response response = sg.api(request);
30+
System.out.println(response.getStatusCode());
31+
System.out.println(response.getBody());
32+
System.out.println(response.getHeaders());
33+
} catch (IOException ex) {
34+
throw ex;
35+
}
36+
}
37+
}
38+

examples/categories/categories.java

-91
This file was deleted.

0 commit comments

Comments
 (0)