Kueri data pengiriman berdasarkan kondisi yang ditentukan
Kueri data pelacakan email berdasarkan kondisi yang ditentukan
Kueri informasi tentang alamat tidak valid
Kueri data pengiriman berdasarkan kondisi yang ditentukan
Deskripsi
Operasi SenderStatisticsByTagNameAndBatchID melakukan kueri data pengiriman berdasarkan kondisi yang ditentukan.
Operasi ini dapat dipanggil hingga 50 kali per menit.
Parameter permintaan
Nama | Tipe | Diperlukan | Deskripsi |
Action | String | Ya | Parameter yang diperlukan. Tetapkan nilainya ke SenderStatisticsByTagNameAndBatchID. |
AccountName | String | Tidak | Alamat pengirim. Jika Anda tidak menentukan parameter ini, data untuk semua alamat pengirim akan dikembalikan. |
TagName | String | Tidak | Tag email. Jika Anda tidak menentukan parameter ini, data untuk semua tag akan dikembalikan. |
StartTime | String | Ya | Awal rentang waktu untuk dikueri. Waktu harus berada dalam 30 hari terakhir. Formatnya adalah yyyy-MM-dd. |
EndTime | String | Ya | Akhir rentang waktu untuk dikueri. Rentang waktu tidak boleh melebihi 7 hari. Formatnya adalah yyyy-MM-dd. |
Untuk informasi selengkapnya, lihat Parameter permintaan umum.
Parameter respons
Nama | Tipe | Deskripsi |
TotalCount | Integer | Jumlah total catatan. |
Data | Array | Catatan data. |
Data
Nama | Tipe | Deskripsi |
createTime | String | Waktu saat catatan dibuat. |
faildCount | String | Jumlah kegagalan |
requestCount | String | Jumlah permintaan pengiriman. |
succeededPercent | String | Laju keberhasilan |
successCount | String | Jumlah keberhasilan |
unavailableCount | String | Jumlah email tidak valid. |
unavailablePercent | String | Inefisiensi |
Untuk informasi selengkapnya, lihat Parameter respons umum.
Kode kesalahan
Kode kesalahan | Deskripsi | Kode status HTTP | Makna |
InvalidDate.Malformed | Format waktu tidak valid. | ||
InvalidDate.NotFound | Waktu tidak ditentukan. | ||
InvalidStartTime.Malformed | Format waktu mulai tidak valid. | ||
InvalidBetweenTime.Malformed | Rentang waktu melebihi batas yang diizinkan. | ||
InvalidMailAddressName.Malformed | Alamat pengirim tidak valid. | ||
InvalidMailAddress.NotFound | Alamat pengirim tidak ada. | ||
InvalidTagName.Malformed | Tag email tidak valid. | ||
InvalidYear.Malformed | Tahun yang ditentukan tidak valid. | ||
InternalError | Terjadi kesalahan yang tidak diketahui. |
Kueri data pelacakan email berdasarkan kondisi yang ditentukan
Deskripsi
Operasi GetTrackListByMailFromAndTagName melakukan kueri data pelacakan email berdasarkan kondisi yang ditentukan.
Parameter permintaan
Nama | Tipe | Diperlukan | Deskripsi |
Action | String | Ya | Parameter yang diperlukan. Tetapkan nilainya ke GetTrackListByMailFromAndTagName. |
AccountName | String | Tidak | Alamat pengirim. Jika Anda tidak menentukan parameter ini, data untuk semua alamat pengirim akan dikembalikan. Parameter ini wajib jika Anda menentukan TagName. |
TagName | String | Tidak | Tag email. Jika Anda tidak menentukan parameter ini, data untuk semua tag akan dikembalikan. |
StartTime | String | Ya | Awal rentang waktu untuk dikueri. Waktu harus berada dalam 30 hari terakhir. Formatnya adalah yyyy-MM-dd. |
EndTime | String | Ya | Akhir rentang waktu untuk dikueri. Rentang waktu tidak boleh melebihi 15 hari. Formatnya adalah yyyy-MM-dd. |
Total | String | Tidak | Parameter ini sudah tidak digunakan lagi. |
Offset | String | Ya | Tetapkan nilai ke 0 untuk kueri pertama dan 1 untuk kueri berikutnya. Nilai 1 menunjukkan kueri berhalaman secara kronologis. Parameter ini sudah tidak digunakan lagi. |
PageSize | String | Tidak | Ukuran halaman |
OffsetCreateTime | String | Tidak | Digunakan untuk penomoran halaman. Jangan atur parameter ini untuk kueri pertama. Untuk kueri berikutnya, atur ke nilai sOffsetCreateTime dari respons sebelumnya. Parameter ini sudah tidak digunakan lagi. |
OffsetCreateTimeDesc | String | Tidak | Parameter ini sudah tidak digunakan lagi. |
PageNumber | String | Tidak | Nomor halaman. |
Untuk informasi selengkapnya, lihat Parameter permintaan umum.
Parameter respons
Nama | Tipe | Deskripsi |
OffsetCreateTime | String | Digunakan untuk penomoran halaman. |
OffsetCreateTimeDesc | String | Parameter ini sudah tidak digunakan lagi. |
PageNo | Integer | Nomor halaman. |
PageSize | Integer | Ukuran halaman |
TrackList | Array | Catatan pelacakan email. |
Total | Integer | Parameter ini sudah tidak digunakan lagi. |
TrackList
Nama | Tipe | Deskripsi |
CreateTime | String | Waktu saat catatan dibuat. |
RcptClickCount | String | Jumlah total klik. |
RcptOpenCount | String | Jumlah total pembukaan. |
RcptUniqueClickCount | String | Jumlah klik unik. |
RcptUniqueClickRate | String | Tingkat klik unik. |
RcptUniqueOpenCount | String | Jumlah dibuka unik. |
RcptUniqueOpenRate | String | Tingkat pembukaan unik. |
TotalNumber | String | Total |
Untuk informasi selengkapnya, lihat Parameter respons umum.
Kode kesalahan
Kode kesalahan | Deskripsi | Kode status HTTP | Makna |
InvalidDate.Malformed | Format waktu tidak valid. | ||
InvalidDate.NotFound | Waktu tidak ditentukan. | ||
InvalidStartTime.Malformed | Format waktu mulai tidak valid. | ||
InvalidBetweenTime.Malformed | Rentang waktu melebihi batas yang diizinkan. | ||
InvalidMailAddressName.Malformed | Alamat pengirim tidak valid. | ||
InvalidMailAddress.NotFound | Alamat pengirim tidak ada. | ||
InvalidTagName.Malformed | Tag email tidak valid. | ||
InvalidYear.Malformed | Tahun yang ditentukan tidak valid. | ||
InternalError | Terjadi kesalahan yang tidak diketahui. |
Kueri data pelacakan email
Deskripsi
Operasi GetTrackList melakukan kueri data pelacakan email.
Parameter permintaan
Nama | Tipe | Diperlukan | Deskripsi |
Action | String | Ya | Parameter yang diperlukan. Tetapkan nilainya ke GetTrackList. |
StartTime | String | Ya | Awal rentang waktu untuk dikueri. Waktu harus berada dalam 30 hari terakhir. Formatnya adalah yyyy-MM-dd. |
EndTime | String | Ya | Akhir rentang waktu untuk dikueri. Rentang waktu tidak boleh melebihi 7 hari. Formatnya adalah yyyy-MM-dd. |
Total | String | Tidak | Parameter ini sudah tidak digunakan lagi. |
Offset | String | Tidak | Tetapkan nilai ke 0 untuk kueri pertama dan 1 untuk kueri berikutnya. Nilai 1 menunjukkan kueri berhalaman secara kronologis. Parameter ini sudah tidak digunakan lagi. |
OffsetCreateTime | String | Tidak | Digunakan untuk penomoran halaman. |
OffsetCreateTimeDesc | String | Tidak | Parameter ini sudah tidak digunakan lagi. |
PageNumber | String | Tidak | Nomor halaman. |
PageSize | String | Tidak | Jumlah catatan pada setiap halaman. |
Untuk informasi selengkapnya, lihat Parameter permintaan umum.
Parameter respons
Nama | Tipe | Deskripsi |
OffsetCreateTime | String | Digunakan untuk penomoran halaman. |
OffsetCreateTimeDesc | String | Parameter ini sudah tidak digunakan lagi. |
Total | Integer | Parameter ini sudah tidak digunakan lagi. |
PageNo | Integer | Nomor halaman. |
PageSize | Integer | Jumlah catatan pada setiap halaman. |
Data | Array | Catatan pelacakan email. |
Data
Nama | Tipe | Deskripsi |
CreateTime | String | Waktu saat catatan dibuat. |
RcptClickCount | String | Jumlah total klik. |
RcptOpenCount | String | Jumlah total pembukaan. |
RcptUniqueClickCount | String | Jumlah klik unik. |
RcptUniqueClickRate | String | Tingkat klik unik. |
RcptUniqueOpenCount | String | Jumlah dibuka unik. |
RcptUniqueOpenRate | String | Tingkat pembukaan unik. |
TotalNumber | String | Total |
RcptClickRate | String | Tingkat klik. |
RcptOpenRate | String | Tingkat buka. |
Untuk informasi selengkapnya, lihat Parameter respons umum.
Kode kesalahan
Kode kesalahan | Deskripsi | Kode status HTTP | Makna |
InvalidDate.Malformed | Format waktu tidak valid. | ||
InvalidDate.NotFound | Waktu tidak ditentukan. | ||
InvalidStartTime.Malformed | Format waktu mulai tidak valid. | ||
InvalidBetweenTime.Malformed | Rentang waktu melebihi batas yang diizinkan. | ||
InvalidMailAddressName.Malformed | Alamat pengirim tidak valid. | ||
InvalidMailAddress.NotFound | Alamat pengirim tidak ada. | ||
InvalidTagName.Malformed | Tag email tidak valid. | ||
InvalidYear.Malformed | Tahun yang ditentukan tidak valid. | ||
InternalError | Terjadi kesalahan yang tidak diketahui. |
Kueri informasi tentang alamat tidak valid
Deskripsi
Operasi QueryInvalidAddress melakukan kueri informasi tentang alamat tidak valid dan menghapus duplikat hasilnya. Jika Anda mengirim email ke alamat tidak valid yang sama beberapa kali, hanya kejadian pertama yang dicatat. Anda dapat melakukan kueri informasi berdasarkan waktu saat alamat tersebut pertama kali diklasifikasikan sebagai tidak valid.
Parameter permintaan
Nama | Tipe | Diperlukan | Deskripsi |
Action | String | Ya | Parameter yang diperlukan. Tetapkan nilainya ke QueryInvalidAddress. |
StartTime | String | Tidak | Awal rentang waktu untuk dikueri. Waktu harus berada dalam 30 hari terakhir. Formatnya adalah yyyy-MM-dd. |
EndTime | String | Tidak | Akhir rentang waktu untuk dikueri. Rentang waktu tidak boleh melebihi 30 hari. Formatnya adalah yyyy-MM-dd. |
KeyWord | String | Tidak | Kata kunci untuk kueri. Jika Anda tidak menentukan parameter ini, semua alamat tidak valid akan dikembalikan. |
Length | Integer | Tidak | Jumlah catatan yang dikembalikan untuk setiap permintaan. |
NextStart | String | Tidak | Posisi awal untuk kueri. |
Untuk informasi selengkapnya, lihat Parameter permintaan umum.
Parameter respons
Nama | Tipe | Deskripsi |
TotalCount | Integer | Jumlah total catatan. |
Data | Array | Data. |
NextStart | String | Posisi awal untuk kueri berikutnya. |
Data
Nama | Tipe | Deskripsi |
mailDetail | List | Catatan. |
mailDetail
Nama | Tipe | Deskripsi |
ToAddress | String | Alamat penerima. |
LastUpdateTime | String | Terakhir diperbarui |
UtcLastUpdateTime | Long | Waktu saat alamat terakhir diperbarui, dalam format Stempel waktu UNIX. |
Untuk informasi selengkapnya, lihat Parameter respons umum.
Kueri detail pengiriman
Deskripsi
Operasi SenderStatisticsDetailByParam melakukan kueri detail email yang telah dikirim.
Operasi ini dapat dipanggil hingga 500 kali per menit.
Parameter permintaan
Nama | Tipe | Diperlukan | Deskripsi |
Action | String | Ya | Parameter yang diperlukan. Tetapkan nilainya ke SenderStatisticsDetailByParam. |
AccountName | String | Tidak | Alamat pengirim. Jika Anda tidak menentukan parameter ini, data untuk semua alamat pengirim akan dikembalikan. Catatan: Anda dapat membiarkan AccountName, TagName, dan ToAddress semuanya kosong. Jika Anda menentukan nilai untuk salah satu parameter ini, Anda hanya boleh menentukan nilai untuk salah satunya. Anda tidak boleh menentukan kombinasi dua atau lebih parameter ini. |
TagName | String | Tidak | Tag email. Jika Anda tidak menentukan parameter ini, data untuk semua tag akan dikembalikan. |
StartTime | String | Tidak | Awal rentang waktu untuk dikueri. Rentang waktu tidak boleh melebihi 30 hari. Formatnya adalah yyyy-MM-dd HH:mm. |
EndTime | String | Tidak | Akhir rentang waktu untuk dikueri. Rentang waktu tidak boleh melebihi 30 hari. Formatnya adalah yyyy-MM-dd HH:mm. |
ToAddress | String | Tidak | Alamat penerima. Jika Anda tidak menentukan parameter ini, data untuk semua alamat penerima akan dikembalikan. |
Status | Integer | Tidak | Status pengiriman. Jika Anda tidak menentukan parameter ini, data untuk semua status akan dikembalikan. Nilai yang valid: 0 (berhasil), 2 (alamat tidak valid), 3 (spam), dan 4 (gagal). |
Length | Integer | Tidak | Jumlah catatan yang dikembalikan dalam respons. Nilainya harus antara 1 dan 100. |
NextStart | String | Tidak | Digunakan untuk penomoran halaman. Menentukan offset untuk permintaan saat ini. Jika masih ada hasil lainnya, atur parameter ini ke nilai NextStart dari respons untuk permintaan berikutnya. |
Untuk informasi selengkapnya, lihat Parameter permintaan umum.
Parameter respons
Nama | Tipe | Deskripsi |
Data | Array | Data. |
NextStart | String | Digunakan untuk penomoran halaman. Jika masih ada hasil lainnya, atur parameter NextStart pada permintaan berikutnya ke nilai ini. |
Data
Nama | Tipe | Deskripsi |
mailDetail | List | Catatan. |
mailDetail
Nama | Tipe | Deskripsi |
ToAddress | String | Alamat penerima. |
LastUpdateTime | String | Waktu saat catatan terakhir diperbarui. |
UtcLastUpdateTime | String | Waktu saat catatan terakhir diperbarui, dalam format Stempel waktu UNIX. |
AccountName | String | Alamat pengirim. |
Message | String | Detail pengiriman. |
Status | Integer | Status pengiriman. Nilai yang valid: 0 (berhasil), 2 (alamat tidak valid), 3 (spam), dan 4 (kegagalan lainnya). |
Subject | String | Subjek email. |
ErrorClassification | String | Klasifikasi rinci dari kesalahan. Contoh:
dll. |
Untuk informasi selengkapnya, lihat Parameter respons umum.